Skip to content

Latest commit

 

History

History
1275 lines (882 loc) · 37 KB

AdminApi.md

File metadata and controls

1275 lines (882 loc) · 37 KB

multibaas.api.AdminApi

Load the API package

import 'package:multibaas/api.dart';

All URIs are relative to https://your_deployment.multibaas.com/api/v0

Method HTTP request Description
acceptInvite POST /invites/{inviteID} Accept invite
addCorsOrigin POST /cors Add CORS origin
addGroupApiKey PUT /groups/{groupID}/api_keys/{apiKeyID} Add API key to group
addGroupRole PUT /groups/{groupID}/roles/{roleShortName} Add role to group
addGroupUser PUT /groups/{groupID}/users/{userID} Add user to group
checkInvite GET /invites/{inviteID} Check invite
createApiKey POST /api_keys Create API key
deleteApiKey DELETE /api_keys/{apiKeyID} Delete API key
deleteUser DELETE /users/{userID} Delete user
getApiKey GET /api_keys/{apiKeyID} Get API Key
inviteUser POST /invites Invite user
listApiKeys GET /api_keys List API keys
listAuditLogs GET /systemactivities List audit logs
listCorsOrigins GET /cors List CORS origins
listGroups GET /groups List groups
listUserSigners GET /users/{userID}/signers List user signers
listUsers GET /users List users
removeCorsOrigin DELETE /cors/{originID} Remove CORS Origin
removeGroupApiKey DELETE /groups/{groupID}/api_keys/{apiKeyID} Remove API key from group
removeGroupRole DELETE /groups/{groupID}/roles/{roleShortName} Remove role from group
removeGroupUser DELETE /groups/{groupID}/users/{userID} Remove user from group
removeUserSignerCloudWallet DELETE /users/{userID}/cloudwallets/{wallet_address} Remove user cloud wallet signer
removeUserSignerWeb3Wallet DELETE /users/{userID}/web3wallets/{wallet_address} Remove user web3 wallet signer
setUserSignerCloudWallet PUT /users/{userID}/cloudwallets/{wallet_address} Add or update user cloud wallet signer
setUserSignerWeb3Wallet PUT /users/{userID}/web3wallets/{wallet_address} Add or update user web3 wallet signer
updateApiKey PUT /api_keys/{apiKeyID} Update API key

acceptInvite

AcceptInvite200Response acceptInvite(inviteID, acceptInviteRequest)

Accept invite

Accepts a user invite.

Example

import 'package:multibaas/api.dart';

final api = Multibaas().getAdminApi();
final String inviteID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final AcceptInviteRequest acceptInviteRequest = ; // AcceptInviteRequest | 

try {
    final response = api.acceptInvite(inviteID, acceptInviteRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->acceptInvite: $e\n');
}

Parameters

Name Type Description Notes
inviteID String
acceptInviteRequest AcceptInviteRequest [optional]

Return type

AcceptInvite200Response

Authorization

bearer

HTTP request headers

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

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

addCorsOrigin

BaseResponse addCorsOrigin(cORSOrigin)

Add CORS origin

Adds a CORS origin.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final CORSOrigin cORSOrigin = ; // CORSOrigin | 

try {
    final response = api.addCorsOrigin(cORSOrigin);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->addCorsOrigin: $e\n');
}

Parameters

Name Type Description Notes
cORSOrigin CORSOrigin [optional]

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

addGroupApiKey

BaseResponse addGroupApiKey(groupID, apiKeyID)

Add API key to group

Adds an API key to a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final int apiKeyID = 789; // int | 

try {
    final response = api.addGroupApiKey(groupID, apiKeyID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->addGroupApiKey: $e\n');
}

Parameters

Name Type Description Notes
groupID int
apiKeyID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

addGroupRole

BaseResponse addGroupRole(groupID, roleShortName)

Add role to group

Adds a role to a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final String roleShortName = roleShortName_example; // String | 

try {
    final response = api.addGroupRole(groupID, roleShortName);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->addGroupRole: $e\n');
}

Parameters

Name Type Description Notes
groupID int
roleShortName String

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

addGroupUser

BaseResponse addGroupUser(groupID, userID)

Add user to group

Adds a user to a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final int userID = 789; // int | 

try {
    final response = api.addGroupUser(groupID, userID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->addGroupUser: $e\n');
}

Parameters

Name Type Description Notes
groupID int
userID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

checkInvite

BaseResponse checkInvite(inviteID)

Check invite

Checks if a user invite is valid.

Example

import 'package:multibaas/api.dart';

final api = Multibaas().getAdminApi();
final String inviteID = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.checkInvite(inviteID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->checkInvite: $e\n');
}

Parameters

Name Type Description Notes
inviteID String

Return type

BaseResponse

Authorization

No authorization required

HTTP request headers

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

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

createApiKey

CreateApiKey200Response createApiKey(createApiKeyRequest)

Create API key

Creates an API key and adds it to group IDs.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final CreateApiKeyRequest createApiKeyRequest = ; // CreateApiKeyRequest | 

try {
    final response = api.createApiKey(createApiKeyRequest);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->createApiKey: $e\n');
}

Parameters

Name Type Description Notes
createApiKeyRequest CreateApiKeyRequest [optional]

Return type

CreateApiKey200Response

Authorization

cookie, bearer

HTTP request headers

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

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

deleteApiKey

BaseResponse deleteApiKey(apiKeyID)

Delete API key

Deletes an API key.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int apiKeyID = 789; // int | 

try {
    final response = api.deleteApiKey(apiKeyID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->deleteApiKey: $e\n');
}

Parameters

Name Type Description Notes
apiKeyID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

deleteUser

BaseResponse deleteUser(userID)

Delete user

Deletes a user.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 

try {
    final response = api.deleteUser(userID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->deleteUser: $e\n');
}

Parameters

Name Type Description Notes
userID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

getApiKey

CreateApiKey200Response getApiKey(apiKeyID)

Get API Key

Returns an API key.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int apiKeyID = 789; // int | 

try {
    final response = api.getApiKey(apiKeyID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->getApiKey: $e\n');
}

Parameters

Name Type Description Notes
apiKeyID int

Return type

CreateApiKey200Response

Authorization

cookie, bearer

HTTP request headers

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

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

inviteUser

BaseResponse inviteUser(invite)

Invite user

Invites a new user.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final Invite invite = ; // Invite | 

try {
    final response = api.inviteUser(invite);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->inviteUser: $e\n');
}

Parameters

Name Type Description Notes
invite Invite [optional]

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

listApiKeys

ListApiKeys200Response listApiKeys(all)

List API keys

Returns all the API keys.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final bool all = true; // bool | If true, returns all API keys on the system, otherwise, returns only the API keys owned by the calling user.

try {
    final response = api.listApiKeys(all);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listApiKeys: $e\n');
}

Parameters

Name Type Description Notes
all bool If true, returns all API keys on the system, otherwise, returns only the API keys owned by the calling user. [optional]

Return type

ListApiKeys200Response

Authorization

cookie, bearer

HTTP request headers

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

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

listAuditLogs

ListAuditLogs200Response listAuditLogs()

List audit logs

Returns the audit logs.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();

try {
    final response = api.listAuditLogs();
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listAuditLogs: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

ListAuditLogs200Response

Authorization

cookie, bearer

HTTP request headers

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

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

listCorsOrigins

ListCorsOrigins200Response listCorsOrigins()

List CORS origins

Returns a list of CORS origins.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();

try {
    final response = api.listCorsOrigins();
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listCorsOrigins: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

ListCorsOrigins200Response

Authorization

cookie, bearer

HTTP request headers

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

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

listGroups

ListGroups200Response listGroups(userID, apiKeyID, assignable)

List groups

Returns all the groups.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 
final int apiKeyID = 789; // int | 
final bool assignable = true; // bool | 

try {
    final response = api.listGroups(userID, apiKeyID, assignable);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listGroups: $e\n');
}

Parameters

Name Type Description Notes
userID int [optional]
apiKeyID int [optional]
assignable bool [optional]

Return type

ListGroups200Response

Authorization

cookie, bearer

HTTP request headers

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

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

listUserSigners

ListUserSigners200Response listUserSigners(userID)

List user signers

Returns all the signers for a user.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 

try {
    final response = api.listUserSigners(userID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listUserSigners: $e\n');
}

Parameters

Name Type Description Notes
userID int

Return type

ListUserSigners200Response

Authorization

cookie, bearer

HTTP request headers

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

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

listUsers

ListUsers200Response listUsers(groupID)

List users

Returns all the users.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 

try {
    final response = api.listUsers(groupID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->listUsers: $e\n');
}

Parameters

Name Type Description Notes
groupID int [optional]

Return type

ListUsers200Response

Authorization

cookie, bearer

HTTP request headers

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

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

removeCorsOrigin

BaseResponse removeCorsOrigin(originID)

Remove CORS Origin

Removes a CORS origin.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int originID = 789; // int | 

try {
    final response = api.removeCorsOrigin(originID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeCorsOrigin: $e\n');
}

Parameters

Name Type Description Notes
originID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

removeGroupApiKey

BaseResponse removeGroupApiKey(groupID, apiKeyID)

Remove API key from group

Removes an API key from a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final int apiKeyID = 789; // int | 

try {
    final response = api.removeGroupApiKey(groupID, apiKeyID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeGroupApiKey: $e\n');
}

Parameters

Name Type Description Notes
groupID int
apiKeyID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

removeGroupRole

BaseResponse removeGroupRole(groupID, roleShortName)

Remove role from group

Removes a role from a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final String roleShortName = roleShortName_example; // String | 

try {
    final response = api.removeGroupRole(groupID, roleShortName);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeGroupRole: $e\n');
}

Parameters

Name Type Description Notes
groupID int
roleShortName String

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

removeGroupUser

BaseResponse removeGroupUser(groupID, userID)

Remove user from group

Removes a user from a group.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int groupID = 789; // int | 
final int userID = 789; // int | 

try {
    final response = api.removeGroupUser(groupID, userID);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeGroupUser: $e\n');
}

Parameters

Name Type Description Notes
groupID int
userID int

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

removeUserSignerCloudWallet

BaseResponse removeUserSignerCloudWallet(userID, walletAddress)

Remove user cloud wallet signer

Removes a cloud wallet signer from a user.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 
final String walletAddress = walletAddress_example; // String | An HSM ethereum address.

try {
    final response = api.removeUserSignerCloudWallet(userID, walletAddress);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeUserSignerCloudWallet: $e\n');
}

Parameters

Name Type Description Notes
userID int
walletAddress String An HSM ethereum address.

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

removeUserSignerWeb3Wallet

BaseResponse removeUserSignerWeb3Wallet(userID, walletAddress)

Remove user web3 wallet signer

Removes a web3 wallet signer from a user.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 
final String walletAddress = walletAddress_example; // String | An HSM ethereum address.

try {
    final response = api.removeUserSignerWeb3Wallet(userID, walletAddress);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->removeUserSignerWeb3Wallet: $e\n');
}

Parameters

Name Type Description Notes
userID int
walletAddress String An HSM ethereum address.

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

setUserSignerCloudWallet

BaseResponse setUserSignerCloudWallet(userID, walletAddress)

Add or update user cloud wallet signer

Adds or updates a user's cloud wallet signer.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 
final String walletAddress = walletAddress_example; // String | An HSM ethereum address.

try {
    final response = api.setUserSignerCloudWallet(userID, walletAddress);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->setUserSignerCloudWallet: $e\n');
}

Parameters

Name Type Description Notes
userID int
walletAddress String An HSM ethereum address.

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

setUserSignerWeb3Wallet

BaseResponse setUserSignerWeb3Wallet(userID, walletAddress, signerLabel)

Add or update user web3 wallet signer

Adds or updates a user's web3 wallet signer.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int userID = 789; // int | 
final String walletAddress = walletAddress_example; // String | An HSM ethereum address.
final SignerLabel signerLabel = ; // SignerLabel | 

try {
    final response = api.setUserSignerWeb3Wallet(userID, walletAddress, signerLabel);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->setUserSignerWeb3Wallet: $e\n');
}

Parameters

Name Type Description Notes
userID int
walletAddress String An HSM ethereum address.
signerLabel SignerLabel [optional]

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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

updateApiKey

BaseResponse updateApiKey(apiKeyID, baseAPIKey)

Update API key

Updates an API key.

Example

import 'package:multibaas/api.dart';
// TODO Configure API key authorization: cookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';

final api = Multibaas().getAdminApi();
final int apiKeyID = 789; // int | 
final BaseAPIKey baseAPIKey = ; // BaseAPIKey | 

try {
    final response = api.updateApiKey(apiKeyID, baseAPIKey);
    print(response);
} catch on DioException (e) {
    print('Exception when calling AdminApi->updateApiKey: $e\n');
}

Parameters

Name Type Description Notes
apiKeyID int
baseAPIKey BaseAPIKey [optional]

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

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

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