UsersApi.md

fireblocks.UsersApi

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

Method	HTTP request	Description
get_users	GET /users	List users

get_users

List[UserResponse] get_users()

List users

List all users for the workspace. Please note that this endpoint is available only for API keys with Admin permissions.

Example

from fireblocks.models.user_response import UserResponse
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:
        # List users
        api_response = fireblocks.users.get_users().result()
        print("The response of UsersApi->get_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersApi->get_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[UserResponse]

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	List of users	* X-Request-ID -
0	Error Response	* X-Request-ID -

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