Get user groups

1 min

GET

https://usermgmt-api.optimizely.com/api/usergroups

Get a page of user groups.

Query Parameters

namestring
Description
Name of the user group.
descriptionstring
Description
Description of the user group.
organizationIdstring
Description
Organization ID that the user group belongs to.
groupOwnerstring
Description
Email address of the user group owner.
propertiesobject[]
Description
Additional properties of the user group.
- namestring
- valuestring
usersstring[]
Description
Email addresses of users in the user group.
instanceIdsstring[]
Description
Instance IDs of the user group.
roleIdsstring[]
Description
IDs of the roles in the user group.
attributeIdsstring[]
Description
IDs of attributes for the user group.
useExactMatchSearchboolean
Description
True or false, indicating whether to perform an exact match or partial word search on the name parameter, if specified.
matchAnyInstanceIdboolean
Description
True or false, indicating whether to match any ID you provide in instanceIds.
groupTypesstring[]
Description
User group types. Possible values: 0 for Custom Defined, 1 for Internal Defined, 2 for Product Defined user group types.
productIdsstring[]
Description
Product IDs associated with the user group.
excludeTeamsboolean
Description
True or false, indicating whether to exclude Teams usergroups from the results. Defaults to true.
sizeinteger<int32>
Description
Number of results to include per page.
Format
int32
offsetinteger<int32>
Description
Offset paging of results.
Format
int32

Responses

200The user groups response.

page_userGroup
- totalItemCountinteger<int32>
  Format
  int32
- itemsuserGroup[]
  - idstring
  - namestring
  - descriptionstring
  - organizationIdstring
  - groupOwnerstring
  - userCountinteger<int32>
    Format
    int32
  - groupTypeinteger<int32>
    Default
    0
    Format
    int32
    Allowed
    012
  - propertiesproperty[]
    - namestring
    - valuestring
  - instancePermissionsinstancePermissionsDescriptor[]
    - instanceIdstring
    - 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
  - 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/usergroups?properties=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/usergroups?properties=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/usergroups?properties=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/usergroups?properties=array"

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

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

print(response.text)

200

// The user groups response.
{
  "totalItemCount": "",
  "items": [
    {
      "id": "",
      "name": "",
      "description": "",
      "organizationId": "",
      "groupOwner": "",
      "userCount": "",
      "groupType": "",
      "properties": [
        {
          "name": "",
          "value": ""
        }
      ],
      "instancePermissions": [
        {
          "instanceId": "",
          "roles": [
            {
              "name": "",
              "id": "",
              "properties": [
                {
                  "name": "",
                  "value": ""
                }
              ],
              "attributes": [
                {
                  "id": "",
                  "key": "",
                  "values": [
                    ""
                  ],
                  "instanceId": "",
                  "type": "",
                  "name": "",
                  "description": "",
                  "productId": "",
                  "isActive": false,
                  "created": "",
                  "modified": "",
                  "links": [
                    {
                      "rel": "",
                      "href": ""
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "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.