Access Control

Manage user access

Account Accesses

List User & Invite account accesses

get

Get list of account accesses for which specifier_type is User or Invite. You have to have account admin/owner permissions for this endpoint to work.

If you specify project_ids, inbox_ids or domain_ids, the endpoint will return account accesses for these resources.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Query parameters

project_idsstring[]Optional

The identifiers of the projects for which to include the results

Example: ["3938"]

inbox_idsstring[]Optional

The identifiers of the inboxes for which to include the results

Example: ["3757"]

domain_idsstring[]Optional

The identifiers of the domains for which to include the results

Example: ["3883"]

Responses

200

OK

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get

/api/accounts/{account_id}/account_accesses

Node.jsPHPPythonC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const accesses = await client.accountAccesses.list();
accesses.forEach(access => console.log(`User: ${access.specifier.email}, Level: ${access.permission_level}`));

[
  {
    "id": 42,
    "specifier_type": "User",
    "specifier": {
      "id": 1,
      "email": "[email protected]",
      "name": "text",
      "two_factor_authentication_enabled": true
    },
    "resources": [
      {
        "resource_id": 1,
        "resource_type": "account",
        "access_level": 1000
      }
    ],
    "permissions": {
      "can_read": true,
      "can_update": true,
      "can_destroy": true,
      "can_leave": true
    }
  }
]

Remove account access

delete

If specifier type is User, it removes user permissions.

If specifier type is Invite or ApiToken, it removes specifier along with permissions.

You have to be an account admin/owner for this endpoint to work.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

account_access_idinteger · int64 · min: 1Required

Unique account access ID

Example: 4788

Responses

200

Returns confirmation of successful deletion and id of the deleted access.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

delete

/api/accounts/{account_id}/account_accesses/{account_access_id}

Node.jsPHPPythonC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
await client.accountAccesses.delete(accessId);

{
  "id": 2981
}