Get instance permissions for user

1 min

GET

https://usermgmt-api.optimizely.com/api/users/{email}/instancepermissions

Get a page of instance permissions for a user.

Path Parameters

emailstringrequired
Description
Email address of the user.

Query Parameters

instanceIdstring
productIdstring
Description
ID of the product the user is assigned to.
customerIdstring
Description
ID of the organization the user is assigned to.
instancePropertiesobject[]
Description
The properties of the instance the user is assigned to.
- namestring
- valuestring
productTypestring
Description
The type of the product the user is assigned to.
sizeinteger<int32>
Description
Number of results to include per page.
Format
int32
offsetinteger<int32>
Description
Offset paging of results.
Format
int32

Responses

200The instance permissions response.

page_instancePermissionsForUser
- totalItemCountinteger<int32>
  Format
  int32
- itemsinstancePermissionsForUser[]
  - instanceIdstring
  - instanceNamestring
  - instanceNicknamestring
  - navigationUrlstring
  - regionstring
  - groupNamestring
  - groupIdstring
  - productIdstring
  - productNamestring
  - productTypeinteger<int32>
    Default
    0
    Format
    int32
    Allowed
    01
  - allowCustomerDefinedRolesboolean
  - hasUsageDashboardboolean
  - isServiceboolean
  - isHomeOrganizationboolean
  - organizationNamestring
  - organizationIdstring
  - rolesroleDescriptor[]
    - namestring
    - idstring
    - propertiesproperty[]
      - namestring
      - valuestring
    - attributesattribute[]
      - idstring
      - keystring
      - valuesstring[]
      - instanceIdstring
      - typestring
      - namestring
      - descriptionstring
      - productIdstring
      - isActiveboolean
      - createdstring<date-time>
        Format
        date-time
      - modifiedstring<date-time>
        Format
        date-time
      - linkslink[]
        relstring
        hrefstring
- linkslink[]
  - relstring
  - hrefstring

400The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

validationError[]
- fieldstring
- codestring
- messagestring

401Unauthorized access to endpoint.

403Forbidden access to endpoint.

500

A server error occurred, please try again.

curl

curl --request GET \
     --url 'https://usermgmt-api.optimizely.com/api/users/{email}/instancepermissions?instanceProperties=array' \
     --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://usermgmt-api.optimizely.com/api/users/{email}/instancepermissions?instanceProperties=array", 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://usermgmt-api.optimizely.com/api/users/{email}/instancepermissions?instanceProperties=array")

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://usermgmt-api.optimizely.com/api/users/{email}/instancepermissions?instanceProperties=array"

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

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

print(response.text)

200

// The instance permissions response.
{
  "totalItemCount": "",
  "items": [
    {
      "instanceId": "",
      "instanceName": "",
      "instanceNickname": "",
      "navigationUrl": "",
      "region": "",
      "groupName": "",
      "groupId": "",
      "productId": "",
      "productName": "",
      "productType": "",
      "allowCustomerDefinedRoles": false,
      "hasUsageDashboard": false,
      "isService": false,
      "isHomeOrganization": false,
      "organizationName": "",
      "organizationId": "",
      "roles": [
        {
          "name": "",
          "id": "",
          "properties": [
            {
              "name": "",
              "value": ""
            }
          ],
          "attributes": [
            {
              "id": "",
              "key": "",
              "values": [
                ""
              ],
              "instanceId": "",
              "type": "",
              "name": "",
              "description": "",
              "productId": "",
              "isActive": false,
              "created": "",
              "modified": "",
              "links": [
                {
                  "rel": "",
                  "href": ""
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "",
      "href": ""
    }
  ]
}

400

// The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
[
  {
    "field": "",
    "code": "",
    "message": ""
  }
]

401

// Unauthorized access to endpoint.

403

// Forbidden access to endpoint.

500

// A server error occurred, please try again.