POST /folders/{id}/permissions

1 min

POST

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

Experimental Grant folder access to users or teams

Path Parameters

idstringrequired
Example
5d7f910551b00a722e0418830cee6631
Description
Unique identifier of the folder

Body Parameters

bodyFolderPermissionBulkCreateRequestrequired
Description
Payload to add list of accessors to folder permissions
- typestring<user | team>required
  Example
  user
  Description
  Type of the accessor
  Allowed
  userteam
- permissionsobject[]required
  Description
  List of permissions to be granted to folder
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6632
    Description
    Unique identifier of accessor
  - access_typestring<view | edit>required
    Example
    view
    Description
    level of access the accessor has to the folder
    Allowed
    viewedit
  - is_ownerboolean
    Description
    Indicates if the accessor is the owner of the folder. A team cannot be an owner.
    Default
    false

Responses

204Permission access granted

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 POST \
     --url https://api.cmp.optimizely.com/v3/folders/{id}/permissions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": "user",
     "permissions": [
     {
     "id": "5d7f910551b00a722e0418830cee6632",
     "access_type": "view"
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "type": "user",
   "permissions": [
      {
         "id": "5d7f910551b00a722e0418830cee6632",
         "access_type": "view"
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   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::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": "user",
   "permissions": [
      {
         "id": "5d7f910551b00a722e0418830cee6632",
         "access_type": "view"
      }
   ]
})

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

python

import requests
import json

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

payload = json.dumps({
   "type": "user",
   "permissions": [
      {
         "id": "5d7f910551b00a722e0418830cee6632",
         "access_type": "view"
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

204

// Permission access granted

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": ""
}