Access Groups API
Create Access Group
POST
/api/v0/create-access-group
Prepare an access group transaction to create a new access group. Transaction needs to be signed and submitted through api/v0/submit-transaction
before changes come into effect.
Endpoint implementation in backend.
Request Body
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the user creating the access group. This user will be the owner of the access group.
AccessGroupPublicKeyBase58Check*
String
Public key of the access group that is being created.
AccessGroupKeyName*
String
Name of the access group that is being created.
MinFeeRateNanosPerKB
uint64
Rate per KB
TransactionFees
TransactionFee[]
Array of
objects that define additional outputs that need to be added to this transaction
ExtraData
map[String]String
arbitrary key value data
Update Access Group
POST
/api/v0/update-access-group
Prepare an access group transaction to update an existing access group. Transaction needs to be signed and submitted through api/v0/submit-transaction
before changes come into effect.
Endpoint implementation in backend.
Request Body
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the user updating their access group. This must be the access group owner.
AccessGroupPublicKeyBase58Check*
String
Public key of the access group that is being updated.
AccessGroupKeyName*
String
Name of the access group that is being updated.
MinFeeRateNanosPerKB
uint64
Rate per KB
TransactionFees
TransactionFee[]
Array of
objects that define additional outputs that need to be added to this transaction
ExtraData
map[String]String
arbitrary key value data
Add Access Group Members
POST
/api/v0/add-access-group-members
Prepare an access group member transaction to add new members to an access group. Transaction needs to be signed and submitted through api/v0/submit-transaction
before changes come into effect.
Endpoint implementation in backend.
Request Body
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the access group owner. Must be the public key signing this transaction.
AccessGroupKeyName*
String
Name of the access group to which the members will be added.
AccessGroupMemberList*
AccessGroupMember[]
MinFeeRateNanosPerKB
uint64
Rate per KB
TransactionFees
TransactionFee[]
Array of
objects that define additional outputs that need to be added to this transaction
ExtraData
map[String]String
arbitrary key value data
Remove Access Group Members
POST
/api/v0/remove-access-group-members
Prepare an access group member transaction to remove members from an access group. Transaction needs to be signed and submitted through api/v0/submit-transaction
before changes come into effect.
Endpoint implementation in backend.
Request Body
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the access group owner. Must be the public key signing this transaction.
AccessGroupKeyName*
String
Name of the access group from which the members will be removed.
AccessGroupMemberList*
AccessGroupMember[]
Array of
objects representing the users to be removed from the access group. Please note that EncryptedKey and ExtraData must be excluded from these objects when removing members.
MinFeeRateNanosPerKB
uint64
Rate per KB
TransactionFees
TransactionFee[]
Array of
objects that define additional outputs that need to be added to this transaction
ExtraData
map[String]String
arbitrary key value data
Update Access Group Members
POST
/api/v0/update-access-group-members
Prepare an access group member transaction to update a member in an access group. Note that you can only update the EncryptedKey and ExtraData attributes of an AccessGroupMember's entry. If you need to change the AccessGroupMemberKeyName, you'll need to remove and re-add them. Transaction needs to be signed and submitted through api/v0/submit-transaction
before changes come into effect.
Endpoint implementation in backend.
Request Body
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the access group owner. Must be the public key signing this transaction.
AccessGroupKeyName*
String
Name of the access group in which the members will be updated.
AccessGroupMemberList*
AccessGroupMember[]
MinFeeRateNanosPerKB
uint64
Rate per KB
TransactionFees
TransactionFee[]
Array of
objects that define additional outputs that need to be added to this transaction
ExtraData
map[String]String
arbitrary key value data
Last updated