Skip to main content
POST
/
v1
/
connector-instances
/
{connectorInstanceId}
/
access
Grant connector instance access
curl --request POST \
  --url https://api.openworklabs.com/v1/connector-instances/{connectorInstanceId}/access \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "viewer",
  "orgMembershipId": "<string>",
  "teamId": "<string>",
  "orgWide": false
}
'
{
  "ok": true,
  "item": {
    "id": "<string>",
    "orgMembershipId": "<string>",
    "teamId": "<string>",
    "orgWide": true,
    "role": "viewer",
    "createdByOrgMembershipId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "removedAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

​
connectorInstanceId
string<typeid>
required

Den TypeID with 'cin_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^cin_.*

Body

application/json
​
role
enum<string>
required
Available options:
viewer,
editor,
manager
​
orgMembershipId
string<typeid>

Den TypeID with 'om_' prefix and a 26-character base32 suffix.

Required string length: 29
Pattern: ^om_.*
​
teamId
string<typeid>

Den TypeID with 'tem_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^tem_.*
​
orgWide
boolean
default:false

Response

Connector instance access grant created successfully.

​
ok
boolean
required
​
item
object
required