Access list

The following endpoints let you view and manage the access list (entity ACL) of a key — the users granted a role on it.

List a key's access list

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/teams/{teamId}/keys/{keyId}/access-list

Returns the access list (entity ACL) of a key — the principals granted a role on it.

A caller holding the entity use permission on the key sees every member; any other member of the key's team sees only the Entity Admins. The key must belong to the team in the path.

Requires the locked connections feature to be enabled for the organization the team belongs to; otherwise the endpoint returns 400 (IM903).

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

teamIdinteger · min: 1Required

The ID of the team that owns the key.

Example: 1

keyIdintegerRequired

The ID of the key.

Example: 16

Responses

200

The access-list members visible to the caller.

application/json

400

The locked connections feature is not enabled for the organization (IM903).

403

The caller is not allowed to view this access list (IM002).

404

The key does not exist in the given team (IM309).

get/teams/{teamId}/keys/{keyId}/access-list

HTTPcURLJavaScriptPython

GET /api/v2/teams/{teamId}/keys/{keyId}/access-list HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

{
  "accessList": [
    {
      "membershipType": "user",
      "membershipId": 128,
      "role": "entity:entity-admin",
      "name": "Jane Doe",
      "email": "[e-mail]"
    },
    {
      "membershipType": "user",
      "membershipId": 214,
      "role": "entity:entity-member",
      "name": "John Smith",
      "email": "[e-mail]"
    }
  ]
}

Add a member to a key's access list

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/teams/{teamId}/keys/{keyId}/access-list/users

Adds a user to a key's access list (entity ACL) with a role.

Requires entity manage on the key, and the target user must already be a member of the key's team. Returns 409 when the user is already on the access list and 400 when they are not a team member or the feature is disabled.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

teamIdinteger · min: 1Required

The ID of the team that owns the key.

Example: 1

keyIdintegerRequired

The ID of the key.

Example: 16

Body

application/json

userIdinteger · min: 1Required

The id of the user to add. Must already be a member of the entity's team.

Example: 214

rolestring · enumRequired

The entity-tier role to grant the user on the connection or key.

Example: entity:entity-memberPossible values:

Responses

200

The created access-list member.

application/json

400

The locked connections and keys feature is disabled (IM903), or the user is not a team member / the role is invalid (IM005).

403

The caller lacks entity manage on the key (IM002).

404

The key does not exist in the given team (IM309).

409

The user is already on the key's access list (SC409).

post/teams/{teamId}/keys/{keyId}/access-list/users

HTTPcURLJavaScriptPython

POST /api/v2/teams/{teamId}/keys/{keyId}/access-list/users HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "userId": 214,
  "role": "entity:entity-member"
}

{
  "member": {
    "membershipType": "user",
    "membershipId": 214,
    "role": "entity:entity-member",
    "name": "John Smith",
    "email": "[e-mail]"
  }
}

Remove a member from a key's access list

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/teams/{teamId}/keys/{keyId}/access-list/users/{userId}

Removes a user from a key's access list.

Requires entity manage. Returns 404 if the user is not on the access list, and 409 if removing them would leave the key without an Entity Admin.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

teamIdinteger · min: 1Required

The ID of the team that owns the key.

Example: 1

keyIdintegerRequired

The ID of the key.

Example: 16

userIdinteger · min: 1Required

The ID of the user to remove.

Example: 214

Responses

204

The user was removed from the access list.

No content

400

The locked connections and keys feature is disabled (IM903).

403

The caller lacks entity manage on the key (IM002).

404

The key is not in the team, or the user is not on its access list (IM309 / SC404).

409

Removing the user would leave the key without an Entity Admin (SC409).

delete/teams/{teamId}/keys/{keyId}/access-list/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/v2/teams/{teamId}/keys/{keyId}/access-list/users/{userId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

No content

Change a key access-list member's role

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/teams/{teamId}/keys/{keyId}/access-list/users/{userId}

Changes the entity-tier role of a user already on a key's access list.

Requires entity manage. Returns 404 if the user is not on the access list, and 409 if the change would demote the key's last Entity Admin.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

teamIdinteger · min: 1Required

The ID of the team that owns the key.

Example: 1

keyIdintegerRequired

The ID of the key.

Example: 16

userIdinteger · min: 1Required

The ID of the user whose role to change.

Example: 214

Body

application/json

rolestring · enumRequired

The entity-tier role to set for the user on the connection or key.

Example: entity:entity-adminPossible values:

Responses

200

The updated access-list member.

application/json

400

The locked connections and keys feature is disabled (IM903), or the role is invalid (IM005).

403

The caller lacks entity manage on the key (IM002).

404

The key is not in the team, or the user is not on its access list (IM309 / SC404).

409

The change would leave the key without an Entity Admin (SC409).

patch/teams/{teamId}/keys/{keyId}/access-list/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/v2/teams/{teamId}/keys/{keyId}/access-list/users/{userId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "role": "entity:entity-admin"
}

{
  "member": {
    "membershipType": "user",
    "membershipId": 214,
    "role": "entity:entity-admin",
    "name": "John Smith",
    "email": "[e-mail]"
  }
}