Update Connection Shares

Choose who can use a shared connection in Cirra and what they may do with it: everyone in the organization, roles, and teams, each at its own access level.

PUT

Path

Path parameters

stringrequired

The connection's id, from List Connections.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

array of objectrequired

The whole new share list, replacing the current one. Exactly one organization entry; role entries take roleId (List Roles), team entries teamId (List Teams). Entries read from Get Connection Shares can be sent back without roleName and teamName, which are read-only.

The whole new share list. It replaces the current one: an entry left out is removed. Exactly one organization entry; at most one entry per role or team.

targetTypestringrequired
Who the entry names.
- organizationEveryone in the organization. A share list has exactly one.
- roleEveryone who holds one role (roleId).
- teamEveryone on one team (teamId).
roleIdstring
The role, from List Roles. Required on a role entry; null or left out on the others.
teamIdstring
The team, from List Teams. Required on a team entry; null or left out on the others.
accessLevelstringrequired
What the members the entry matches may do with the connection. none is only for the organization entry.
- noneNo access. Only on the organization entry: members no other entry matches cannot use the connection.
- readRun only actions that read data.
- readWriteRun actions that read, create, or update data.
- fullRun every action, deletes included.
- customAdvanced: run what the entry's own table of record types and operations allows (permissions).
permissionsobject
Required on a custom entry; null or left out on the others. The Advanced table of a custom entry; null on every other level. An action runs through this entry when models[its record type][its operation] is true, else when default[its operation] is true. An action with no record type follows default; one that declares no operation is "unknown". Record types are the canonical keys of app actions (model). Grants from all the entries that match a member add up: a member may run an action when any of them allows it, so false (Blocked) only means this entry does not grant it. A table is saved in one form: record type cells equal to default are dropped, and a table with none left whose default equals a preset is saved as that preset.
- defaultobjectrequired
  Every operation, true or false: what the entry allows on record types models does not name, and on actions with no record type.
  - readbooleanrequired
    Actions that read records.
  - createbooleanrequired
    Actions that create records.
  - updatebooleanrequired
    Actions that update records.
  - deletebooleanrequired
    Actions that delete records.
  - unknownbooleanrequired
    Actions that declare no operation ("Other").
- modelsobjectrequired
  { "<record type>": { "<operation>": true or false } }: the cells that differ from default, by canonical record type key. An operation a record type leaves out follows default.

Response fields

connectionIdstring

The connection (List Connections).

entriesarray of objects

Who may use the connection in Cirra, and how far. A member may do what any entry that matches them allows; its owner, its creator, Platform Admins and members who manage roles always have full. Empty: nothing restricts the connection yet, so every member has full. A list saved since sharing levels shipped always has one organization entry; an older list of roles alone leaves members no entry matches without access.

targetTypestring
Who the entry names.
- organizationEveryone in the organization. A share list has exactly one.
- roleEveryone who holds one role (roleId).
- teamEveryone on one team (teamId).
roleIdstring
The role, for a role entry (List Roles). Null otherwise.
roleNamestring
That role's name. Null for other entries, and for a role deleted since the entry was saved: such an entry matches nobody and can be removed.
teamIdstring
The team, for a team entry (List Teams). Null otherwise.
teamNamestring
That team's name. Null for other entries.
accessLevelstring
What the members it matches may do with the connection.
- noneNo access. Only on the organization entry: members no other entry matches cannot use the connection.
- readRun only actions that read data.
- readWriteRun actions that read, create, or update data.
- fullRun every action, deletes included.
- customAdvanced: run what the entry's own table of record types and operations allows (permissions).
permissionsobject
The Advanced table of a custom entry; null on every other level. An action runs through this entry when models[its record type][its operation] is true, else when default[its operation] is true. An action with no record type follows default; one that declares no operation is "unknown". Record types are the canonical keys of app actions (model). Grants from all the entries that match a member add up: a member may run an action when any of them allows it, so false (Blocked) only means this entry does not grant it. A table is saved in one form: record type cells equal to default are dropped, and a table with none left whose default equals a preset is saved as that preset.
- defaultobject
  Every operation, true or false: what the entry allows on record types models does not name, and on actions with no record type.
  - readboolean
    Actions that read records.
  - createboolean
    Actions that create records.
  - updateboolean
    Actions that update records.
  - deleteboolean
    Actions that delete records.
  - unknownboolean
    Actions that declare no operation ("Other").
- modelsobject
  { "<record type>": { "<operation>": true or false } }: the cells that differ from default, by canonical record type key. An operation a record type leaves out follows default.