Package io.mailtrap.api.accountaccesses
Interface AccountAccesses
- All Known Implementing Classes:
AccountAccessesImpl
public interface AccountAccesses
Interface representing the Mailtrap Testing API for interaction with account accesses
-
Method Summary
Modifier and TypeMethodDescriptionlistUserAndInviteAccountAccesses
(long accountId, ListAccountAccessQueryParams params) Get list of account accesses for which specifier_type is User or Invite.removeAccountAccess
(long accountAccessId, long accountId) If specifier type is User, it removes user permissions.
-
Method Details
-
listUserAndInviteAccountAccesses
List<AccountAccessResponse> listUserAndInviteAccountAccesses(long accountId, ListAccountAccessQueryParams params) Get list of account accesses for which specifier_type is User or Invite. Account admin/owner permissions for this endpoint to work.- Parameters:
accountId
- unique account IDparams
- additional query params. If specified - the endpoint will return account accesses for these resources- Returns:
- account access details
-
removeAccountAccess
If specifier type is User, it removes user permissions. If specifier type is Invite or ApiToken, it removes specifier along with permissions.Account admin/owner permissions for this endpoint to work
- Parameters:
accountAccessId
- unique account access IDaccountId
- unique account ID- Returns:
- confirmation of successful deletion and id of the deleted access
-