GET /folders/{id}/permissions

1 min

GET

https://api.cmp.optimizely.com/v3/folders/{id}/permissions

Experimental List of entities that have permission to access the folder

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the folder

Query Parameters

accessstring
Example
view
Description
To filter by specific access level. Cannot be used in addition to max_access and min_access params.
Allowed
vieweditcommentdelete
max_accessstring
Example
view
Description
To filter by specific access level and higher. Cannot be used in addition to access and min_access params.
Allowed
vieweditcommentdelete
min_accessstring
Example
view
Description
To filter by specific access level and lower. Cannot be used in addition to access and max_access params.
Allowed
vieweditcommentdelete

Responses

200List of permissions

FolderPermissionListResponseItem
- dataBasePermissionsResponseSchema[]required
  Description
  List of Permissions
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    Unique identifier of the accessor
  - typestring<user | team | organization>required
    Example
    user
    Description
    Type of the accessor
    Allowed
    userteamorganization
  - namestringrequired
    Example
    John Doe
    Description
    Name of the accessor
  - is_ownerbooleanrequired
    Description
    Indicates if the accessor is the owner of the object
  - access_typestring<view | edit | comment | delete>required
    Example
    view
    Description
    level of access the accessor has to the resource
    Allowed
    vieweditcommentdelete
  - linksobjectrequired
    - accessorstringrequired
      Example
      https://api.cmp.optimizely.com/v3/users/5f857f30e1c4a2038d6179e9
      Description
      links for user and team type objects
- paginationobjectrequired
  - Pagination
    - nextstringrequired
      Example
      https://api.cmp.optimizely.com/<some-path-to-next-page>?offset=10&page_size=10
      Description
      URL to the next page
    - previousstringrequired
      Description
      URL to the previous page
  - object
    - nextstring
      Example
      https://api.cmp.optimizely.com/v3/folders/c00bfb60703f11ef805602420ac8001b/permissions?offset=10&page_size=10

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/folders/{id}/permissions \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/folders/{id}/permissions", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/folders/{id}/permissions")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/folders/{id}/permissions"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// List of permissions
{
  "data": [
    {
      "id": "5d7f910551b00a722e0418830cee6631",
      "type": "user",
      "name": "John Doe",
      "is_owner": false,
      "access_type": "view",
      "links": {
        "accessor": "https://api.cmp.optimizely.com/v3/users/5f857f30e1c4a2038d6179e9"
      }
    }
  ],
  "pagination": {}
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}