Skip to content

ApiUserApi.md

Latest commit

 

History

History
164 lines (111 loc) · 5.57 KB

ApiUserApi.md

File metadata and controls

164 lines (111 loc) · 5.57 KB

fireblocks.ApiUserApi

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

Method HTTP request Description
create_api_user POST /management/api_users Create API Key
get_api_users GET /management/api_users Get API Keys

create_api_user

create_api_user(idempotency_key=idempotency_key, create_api_user=create_api_user)

Create API Key

Create a new API key in your workspace. Learn more about Fireblocks API Keys management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Example

from fireblocks.models.create_api_user import CreateAPIUser
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_api_user = fireblocks.CreateAPIUser() # CreateAPIUser |  (optional)

    try:
        # Create API Key
        fireblocks.api_user.create_api_user(idempotency_key=idempotency_key, create_api_user=create_api_user).result()
    except Exception as e:
        print("Exception when calling ApiUserApi->create_api_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_api_user CreateAPIUser [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_api_users

GetAPIUsersResponse get_api_users()

Get API Keys

List all API keys in your workspace.

  • Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.
    Endpoint Permission: Admin, Non-Signing Admin.

Example

from fireblocks.models.get_api_users_response import GetAPIUsersResponse
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 API Keys
        api_response = fireblocks.api_user.get_api_users().result()
        print("The response of ApiUserApi->get_api_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ApiUserApi->get_api_users: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetAPIUsersResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 got api 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]