Get Entity Permissions

1 min

GET

https://api.optimizely.com/permissions/projects/{project_id}/{entity_type}/{entity_id}

Path Parameters

project_idintegerrequired
entity_typeEntityTypeInPathrequired
entity_idstringrequired

Responses

200Successful Response

EntityPermissionsResponse
- usersUserPermission[]required
  - roleEntityPermissionrequired
  - role_inheritedEntityPermissionrequired
  - first_nameobjectrequired
  - last_nameobjectrequired
  - user_idstringrequired
  - emailstring<email>required
    Format
    email
- teamsTeamPermission[]required
  - team_idstringrequired
  - namestringrequired
  - rolestringrequired
  - external_refobjectrequired

422Validation Error

HTTPValidationError
- detailValidationError[]
  - locobject[]required
  - msgstringrequired
  - typestringrequired

curl

curl --request GET \
     --url https://api.optimizely.com/permissions/projects/{project_id}/{entity_type}/{entity_id} \
     --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.optimizely.com/permissions/projects/{project_id}/{entity_type}/{entity_id}", 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.optimizely.com/permissions/projects/{project_id}/{entity_type}/{entity_id}")

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.optimizely.com/permissions/projects/{project_id}/{entity_type}/{entity_id}"

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

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

print(response.text)

200

// Successful Response
{
  "users": [
    {
      "role": "",
      "role_inherited": "",
      "first_name": {},
      "last_name": {},
      "user_id": "",
      "email": ""
    }
  ],
  "teams": [
    {
      "team_id": "",
      "name": "",
      "role": "",
      "external_ref": {}
    }
  ]
}

422

// Validation Error
{
  "detail": [
    {
      "loc": [
        {}
      ],
      "msg": "",
      "type": ""
    }
  ]
}