CosignersApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
addCosigner	POST /cosigners	Add cosigner
getCosigner	GET /cosigners/{cosignerId}	Get cosigner
getCosignerApiUser	GET /cosigners/{cosignerId}/api_users/{apiUserId}	Get API user
getCosignerApiUserRequestStatus	GET /cosigners/{cosignerId}/api_users/{apiUserId}/{requestId}	Get API user request status
getCosignerApiUsers	GET /cosigners/{cosignerId}/api_users	Get all API users
getCosigners	GET /cosigners	Get all cosigners
pairCosignerApiUser	PUT /cosigners/{cosignerId}/api_users/{apiUserId}	Pair API user
renameCosigner	PATCH /cosigners/{cosignerId}	Rename cosigner
unpairCosignerApiUser	DELETE /cosigners/{cosignerId}/api_users/{apiUserId}	Unpair API user
updateCosignerApiUserCallbackHandler	PATCH /cosigners/{cosignerId}/api_users/{apiUserId}	Update API user callback handler

addCosigner

CompletableFuture<ApiResponse> addCosigner addCosigner(addCosignerRequest, idempotencyKey)

Add cosigner

Add a new cosigner. The cosigner will be pending pairing until the API user is manually paired (see `pairCosignerApiUser`). Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        AddCosignerRequest addCosignerRequest = new AddCosignerRequest(); // AddCosignerRequest | 
        String idempotencyKey = "idempotencyKey_example"; // String | 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.
        try {
            CompletableFuture<ApiResponse<AddCosignerResponse>> response = fireblocks.cosigners().addCosigner(addCosignerRequest, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#addCosigner");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
addCosignerRequest	AddCosignerRequest
idempotencyKey	String	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]

Return type

CompletableFuture<ApiResponse<AddCosignerResponse>>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Pending cosigner added	* X-Request-ID -
0	Error Response	* X-Request-ID -

getCosigner

CompletableFuture<ApiResponse> getCosigner getCosigner(cosignerId)

Get cosigner

Get a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        try {
            CompletableFuture<ApiResponse<Cosigner>> response = fireblocks.cosigners().getCosigner(cosignerId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#getCosigner");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
cosignerId	UUID	The unique identifier of the cosigner

Return type

CompletableFuture<ApiResponse<Cosigner>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A cosigner object	* X-Request-ID -
0	Error Response	* X-Request-ID -

getCosignerApiUser

CompletableFuture<ApiResponse> getCosignerApiUser getCosignerApiUser(cosignerId, apiUserId)

Get API user

Get an API user by ID. Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String apiUserId = "44fcead0-7053-4831-a53a-df7fb90d440f"; // String | The unique identifier of the API user
        try {
            CompletableFuture<ApiResponse<CosignerApiUser>> response = fireblocks.cosigners().getCosignerApiUser(cosignerId, apiUserId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#getCosignerApiUser");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
cosignerId	UUID	The unique identifier of the cosigner
apiUserId	String	The unique identifier of the API user

Return type

CompletableFuture<ApiResponse<CosignerApiUser>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A CosignerApiUser object	* X-Request-ID -
0	Error Response	* X-Request-ID -

getCosignerApiUserRequestStatus

CompletableFuture<ApiResponse> getCosignerApiUserRequestStatus getCosignerApiUserRequestStatus(cosignerId, apiUserId, requestId)

Get API user request status

Get the status of an asynchronous request Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String apiUserId = "44fcead0-7053-4831-a53a-df7fb90d440f"; // String | The unique identifier of the API user
        String requestId = "requestId_example"; // String | 
        try {
            CompletableFuture<ApiResponse<Status>> response = fireblocks.cosigners().getCosignerApiUserRequestStatus(cosignerId, apiUserId, requestId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#getCosignerApiUserRequestStatus");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
cosignerId	UUID	The unique identifier of the cosigner
apiUserId	String	The unique identifier of the API user
requestId	String

Return type

CompletableFuture<ApiResponse<Status>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The status of the request	* X-Request-ID -
0	Error Response	* X-Request-ID -

getCosignerApiUsers

CompletableFuture<ApiResponse> getCosignerApiUsers getCosignerApiUsers(cosignerId, order, pageCursor, pageSize)

Get all API users

Get all cosigner paired API users (paginated). Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String order = "ASC"; // String | ASC / DESC ordering (default DESC)
        String pageCursor = "pageCursor_example"; // String | Cursor of the required page
        BigDecimal pageSize = new BigDecimal("10"); // BigDecimal | Maximum number of items in the page
        try {
            CompletableFuture<ApiResponse<ApiUsersPaginatedResponse>> response = fireblocks.cosigners().getCosignerApiUsers(cosignerId, order, pageCursor, pageSize);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#getCosignerApiUsers");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
cosignerId	UUID	The unique identifier of the cosigner
order	String	ASC / DESC ordering (default DESC)	[optional] [default to DESC] [enum: ASC, DESC]
pageCursor	String	Cursor of the required page	[optional]
pageSize	BigDecimal	Maximum number of items in the page	[optional] [default to 10]

Return type

CompletableFuture<ApiResponse<ApiUsersPaginatedResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A paginated response containing CosignerApiUser objects	* X-Request-ID -
0	Error Response	* X-Request-ID -

getCosigners

CompletableFuture<ApiResponse> getCosigners getCosigners(order, pageCursor, pageSize)

Get all cosigners

Get all workspace cosigners (paginated). Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        String order = "ASC"; // String | ASC / DESC ordering (default DESC)
        String pageCursor = "pageCursor_example"; // String | Cursor of the required page
        BigDecimal pageSize = new BigDecimal("10"); // BigDecimal | Maximum number of items in the page
        try {
            CompletableFuture<ApiResponse<CosignersPaginatedResponse>> response = fireblocks.cosigners().getCosigners(order, pageCursor, pageSize);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#getCosigners");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
order	String	ASC / DESC ordering (default DESC)	[optional] [default to DESC] [enum: ASC, DESC]
pageCursor	String	Cursor of the required page	[optional]
pageSize	BigDecimal	Maximum number of items in the page	[optional] [default to 10]

Return type

CompletableFuture<ApiResponse<CosignersPaginatedResponse>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A paginated response containing Cosigner objects	* X-Request-ID -
0	Error Response	* X-Request-ID -

pairCosignerApiUser

CompletableFuture<ApiResponse> pairCosignerApiUser pairCosignerApiUser(pairApiUserRequest, cosignerId, apiUserId, idempotencyKey)

Pair API user

Pair an API user to a cosigner Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        PairApiUserRequest pairApiUserRequest = new PairApiUserRequest(); // PairApiUserRequest | 
        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String apiUserId = "44fcead0-7053-4831-a53a-df7fb90d440f"; // String | The unique identifier of the API user
        String idempotencyKey = "idempotencyKey_example"; // String | 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.
        try {
            CompletableFuture<ApiResponse<PairApiUserResponse>> response = fireblocks.cosigners().pairCosignerApiUser(pairApiUserRequest, cosignerId, apiUserId, idempotencyKey);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#pairCosignerApiUser");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pairApiUserRequest	PairApiUserRequest
cosignerId	UUID	The unique identifier of the cosigner
apiUserId	String	The unique identifier of the API user
idempotencyKey	String	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]

Return type

CompletableFuture<ApiResponse<PairApiUserResponse>>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	The API user object to be paired	* X-Request-ID - * Location -
0	Error Response	* X-Request-ID -

renameCosigner

CompletableFuture<ApiResponse> renameCosigner renameCosigner(renameCosigner, cosignerId)

Rename cosigner

Rename a cosigner by ID. Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        RenameCosigner renameCosigner = new RenameCosigner(); // RenameCosigner | 
        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        try {
            CompletableFuture<ApiResponse<Cosigner>> response = fireblocks.cosigners().renameCosigner(renameCosigner, cosignerId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#renameCosigner");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
renameCosigner	RenameCosigner
cosignerId	UUID	The unique identifier of the cosigner

Return type

CompletableFuture<ApiResponse<Cosigner>>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	A cosigner object	* X-Request-ID -
0	Error Response	* X-Request-ID -

unpairCosignerApiUser

CompletableFuture<ApiResponse> unpairCosignerApiUser unpairCosignerApiUser(cosignerId, apiUserId)

Unpair API user

Unpair an API user from a cosigner Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String apiUserId = "44fcead0-7053-4831-a53a-df7fb90d440f"; // String | The unique identifier of the API user
        try {
            CompletableFuture<ApiResponse<CosignerApiUser>> response = fireblocks.cosigners().unpairCosignerApiUser(cosignerId, apiUserId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#unpairCosignerApiUser");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
cosignerId	UUID	The unique identifier of the cosigner
apiUserId	String	The unique identifier of the API user

Return type

CompletableFuture<ApiResponse<CosignerApiUser>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	The API user object to be unpaired	* X-Request-ID - * Location -
0	Error Response	* X-Request-ID -

updateCosignerApiUserCallbackHandler

CompletableFuture<ApiResponse> updateCosignerApiUserCallbackHandler updateCosignerApiUserCallbackHandler(updateCallbackHandlerRequest, cosignerId, apiUserId)

Update API user callback handler

Update the callback handler of an API user Endpoint Permission: Admin and Non-Signing Admin.

Example

// Import classes:
import com.fireblocks.sdk.ApiClient;
import com.fireblocks.sdk.ApiException;
import com.fireblocks.sdk.ApiResponse;
import com.fireblocks.sdk.BasePath;
import com.fireblocks.sdk.Fireblocks;
import com.fireblocks.sdk.ConfigurationOptions;
import com.fireblocks.sdk.model.*;
import com.fireblocks.sdk.api.CosignersApi;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;

public class Example {
    public static void main(String[] args) {
        ConfigurationOptions configurationOptions = new ConfigurationOptions()
            .basePath(BasePath.Sandbox)
            .apiKey("my-api-key")
            .secretKey("my-secret-key");
        Fireblocks fireblocks = new Fireblocks(configurationOptions);

        UpdateCallbackHandlerRequest updateCallbackHandlerRequest = new UpdateCallbackHandlerRequest(); // UpdateCallbackHandlerRequest | 
        UUID cosignerId = UUID.fromString("44fcead0-7053-4831-a53a-df7fb90d440f"); // UUID | The unique identifier of the cosigner
        String apiUserId = "44fcead0-7053-4831-a53a-df7fb90d440f"; // String | The unique identifier of the API user
        try {
            CompletableFuture<ApiResponse<UpdateCallbackHandlerResponse>> response = fireblocks.cosigners().updateCosignerApiUserCallbackHandler(updateCallbackHandlerRequest, cosignerId, apiUserId);
            System.out.println("Status code: " + response.get().getStatusCode());
            System.out.println("Response headers: " + response.get().getHeaders());
            System.out.println("Response body: " + response.get().getData());
        } catch (InterruptedException | ExecutionException e) {
            ApiException apiException = (ApiException)e.getCause();
            System.err.println("Exception when calling CosignersApi#updateCosignerApiUserCallbackHandler");
            System.err.println("Status code: " + apiException.getCode());
            System.err.println("Response headers: " + apiException.getResponseHeaders());
            System.err.println("Reason: " + apiException.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description
updateCallbackHandlerRequest	UpdateCallbackHandlerRequest
cosignerId	UUID	The unique identifier of the cosigner
apiUserId	String	The unique identifier of the API user

Return type

CompletableFuture<ApiResponse<UpdateCallbackHandlerResponse>>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	The API user object with the new callback handler	* X-Request-ID - * Location -
0	Error Response	* X-Request-ID -

FilesExpand file tree

CosignersApi.md

Latest commit

History

CosignersApi.md

File metadata and controls

CosignersApi

addCosigner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCosigner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCosignerApiUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCosignerApiUserRequestStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCosignerApiUsers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCosigners

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

pairCosignerApiUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

renameCosigner

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unpairCosignerApiUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateCosignerApiUserCallbackHandler

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details