Workspace Permissions

get

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200Success

application/json

pkintegerRead-onlyOptional

workspaceintegerRequired

userintegerRequired

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

get/api/v1/workspace_permissions/

GET /api/v1/workspace_permissions/ HTTP/1.1
Accept: */*

200Success

[
  {
    "pk": 1,
    "workspace": 1,
    "user": 1,
    "role": "OWNER",
    "data_access": true
  }
]

post

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Body

pkintegerRead-onlyOptional

workspaceintegerRequired

userintegerRequired

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

Responses

201Success

application/json

pkintegerRead-onlyOptional

workspaceintegerRequired

userintegerRequired

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

post/api/v1/workspace_permissions/

POST /api/v1/workspace_permissions/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "workspace": 1,
  "user": 1,
  "role": "OWNER",
  "data_access": true
}

201Success

{
  "pk": 1,
  "workspace": 1,
  "user": 1,
  "role": "OWNER",
  "data_access": true
}

get

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

200Success

application/json

pkintegerRead-onlyOptional

workspaceintegerRequired

userintegerRequired

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

get/api/v1/workspace_permissions/{id}/

GET /api/v1/workspace_permissions/{id}/ HTTP/1.1
Accept: */*

200Success

{
  "pk": 1,
  "workspace": 1,
  "user": 1,
  "role": "OWNER",
  "data_access": true
}

delete

Delete a workspace permission.

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

204

No response body

No content

delete/api/v1/workspace_permissions/{id}/

DELETE /api/v1/workspace_permissions/{id}/ HTTP/1.1
Accept: */*

204

No response body

No content

patch

Workspace permissions can only be updated by the workspace owner.

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Body

pkintegerRead-onlyOptional

workspaceintegerOptional

userintegerOptional

rolestring · enumOptional

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

Responses

200Success

application/json

pkintegerRead-onlyOptional

workspaceintegerRequired

userintegerRequired

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

data_accessbooleanOptional

patch/api/v1/workspace_permissions/{id}/

PATCH /api/v1/workspace_permissions/{id}/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "workspace": 1,
  "user": 1,
  "role": "OWNER",
  "data_access": true
}

200Success

{
  "pk": 1,
  "workspace": 1,
  "user": 1,
  "role": "OWNER",
  "data_access": true
}

patch

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Body

rolestring · enumOptional

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

workspacesinteger[]Optional

new_ownerstring · max: 255Optional

data_accessbooleanOptionalDefault: false

Responses

200Success

application/json

rolestring · enumRequired

• OWNER - Owner
• EDITOR - Editor
• READER - Reader

Possible values:

workspacesinteger[]Required

new_ownerstring · max: 255Required

data_accessbooleanOptionalDefault: false

patch/api/v1/workspace_permissions/transfer/

PATCH /api/v1/workspace_permissions/transfer/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "role": "OWNER",
  "workspaces": [
    1
  ],
  "new_owner": "text",
  "data_access": false
}

200Success

{
  "role": "OWNER",
  "workspaces": [
    1
  ],
  "new_owner": "text",
  "data_access": false
}