Access Group Endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
POST /api/v0/get-all-user-access-groups
Get All User Access Groups gets all Access Group Entry Responses representing all access groups owned by the public key as well as access groups of which the public key is a member.
Endpoint implementation in .
PublicKeyBase58Check*
String
Public key of the user for whom we want to get all access groups
POST /api/v0/get-all-user-access-groups-owned
Get All Access Groups Owned gets all Access Group Entry Responses representing all access groups owned by the public key.
PublicKeyBase58Check*
String
Public key of user for whom we want to fetch all groups they own
POST /api/v0/get-all-user-access-groups-member-only
Get All Access Groups Owned gets all Access Group Entry Responses representing all access groups owned by the public key.
PublicKeyBase58Check*
String
Public key of user for whom we want to fetch all groups of which they are a member
POST /api/v0/check-party-access-groups
Check Party Access Groups checks whether both the sender and receiver have the requested access groups. If they do not, it returns the base key.
SenderPublicKeyBase58Check*
String
Public key of sender
SenderAccessGroupKeyName*
String
Access Group Key Name of sender
RecipientPublicKeyBase58Check*
String
Public key of recipient
RecipientAccessGroupKeyName*
String
Access Group Key Name of recipient
POST /api/v0/get-access-group-info
Get Access Group Information gets a single Access Group Entry Response for the access group as defined in the request body.
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the access group owner
AccessGroupKeyName*
String
Access group key name
POST /api/v0/get-access-group-member-info
Get Access Group Member Information gets a single Access Group Member Entry Response for the access group member defined in the request body.
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the group owner
AccessGroupKeyName*
String
Access group key name of the group
AccessGroupMemberPublicKeyBase58Check*
String
Public key of the member for which we want to fetch a AccessGroupMemberEntryResponse
POST /api/v0/get-paginated-access-group-members
Get Paginated Access Group Members gets a page of Access Group Member Entry responses for the access group defined in the request body. This is useful in identifying all members of a group. A map of public key to profile entry response is provided for convenience.
AccessGroupOwnerPublicKeyBase58Check*
String
Public key of the group owner
AccessGroupKeyName*
String
name of the access group
StartingAccessGroupMemberPublicKeyBase58Check
String
Public key of the last result from the previous page. To get the first page, exclude this value or make it an empty string.
MaxMembersToFetch*
int
Maximum number of members to fetch. You will receive at most this number of members.
POST /api/v0/get-bulk-access-group-entries
Get Bulk Access Group Entries returns an array of AccessGroupEntryResponse objects for the request list of group owner + group key name pairs in the request body.
GroupOwnerAndGroupKeyNamePairs*
GroupOwnerAndGroupKeyNamePair[]
An array of objects containing the below attributes.
GroupOwnerPublicKeyBase58Check: the owner of the group
GroupKeyName: the name of the group
This endpoint will return the associated AccessGroupEntryResponse for each object. If the AccessGroupEntryResponse is not found, this object will appear in the PairsNotFound array in the response.
Endpoint implementation in .
Endpoint implementation in .
Endpoint implementation in .
Endpoint implementation in .
Endpoint implementation in .
Endpoint implementation in .
Endpoint implementation in .