access

Embed
Preview of the card
<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-access"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/8b0c5ae2-0cc9-43e0-98f5-67e2235986c9/social-card.svg?v=3e7ae33eec8b" alt="access" width="600" height="315"></a>
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/access-settings

Parameters

project_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/access-settings"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "default_access": "string",
  "type_defaults": {}
}
Schema
default_accessstringrequired
member (every org member) or none (only project members, org owners and admins).
type_defaultsobject
Object type (dashboard, flag, ...) to the level unrestricted objects of that type give: view or edit (the default).
404
PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/access-settings

Parameters

project_idstringpathrequired

Request body

application/json
default_accessstringrequired
member (every org member) or none (only project members, org owners and admins).
type_defaultsobject
Object type (dashboard, flag, ...) to the level unrestricted objects of that type give: view or edit (the default).
{
  "default_access": "string",
  "type_defaults": {}
}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/access-settings" \
  -H "Content-Type: application/json" \
  -d '{"default_access":"string","type_defaults":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

400
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members

Parameters

project_idstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "data": [
    {
      "created_at": "2024-01-01T00:00:00Z",
      "email": "string",
      "level": "string",
      "name": "string",
      "user_id": "string"
    }
  ],
  "next_cursor": "string"
}
Schema
dataobject[]required
Show child parameters
created_atstringrequired
emailstringrequired
levelstringrequired
member | admin
namestringrequired
user_idstringrequired
next_cursorstring
404
PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members/{user_id}

Parameters

project_idstringpathrequired
user_idstringpathrequired

Request body

application/json
levelstringrequired
member | admin
{
  "level": "string"
}

Code samples

cURL
curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members/{user_id}" \
  -H "Content-Type: application/json" \
  -d '{"level":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
400
403
404
DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members/{user_id}

Parameters

project_idstringpathrequired
user_idstringpathrequired

Code samples

cURL
curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/members/{user_id}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

204
403
404
GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/objects/{rtype}/{rid}/access/report

Parameters

project_idstringpathrequired
rtypestringpathrequired
dashboard|insight|folder|flag|experiment|cohort|notebook|action|sql_view
ridstringpathrequired

Code samples

cURL
curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/objects/{rtype}/{rid}/access/report"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200
Example
{
  "data": [
    {
      "email": "string",
      "level": "string",
      "org_role": "string",
      "source": "string",
      "user_id": "string"
    }
  ],
  "next_cursor": "string"
}
Schema
dataobject[]required
Show child parameters
emailstringrequired
levelstringrequired
none | view | edit | manage, before the person's role caps it.
org_rolestringrequired
sourcestringrequired
Where it comes from: org_admin, project_admin, creator, user_grant, team:<names>, default, restricted (restricted with no grant), no_access_grant or private_project.
user_idstringrequired
next_cursorstring
403
404
Updated