latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

Group Management API

Retrieve list of users in a group with specific group ID.

get/api/2.0/groups/{objectId}/users

Path parameters

objectIdinteger required

Group ID to retrieve list of users

Response

Success

createdDateinteger

Created date in milliseconds

lastModDateinteger

Last modified date

idinteger

User ID

usernamestring

User username

namestring

User name

ssoUserboolean

Is SSO user

customerIdinteger

User customer ID

autocycleboolean

Is user eligible for auto-cycle

timeZonestring

User timezone

lastLoginDatestring date-time

User last login date time

managementClientIdstring

Management API client ID

managementClientSecretstring

Management API client secret

externalAuthTypeinteger

External authentication type

rolesstring[]

User roles

permissionsstring[]

User permissions

jsonConfigstring

Role JSON config (viz settings, etc.)

twoFactorBySmsboolean

Is two factor login by SMS enabled

phonestring

User phone number

twoFactorByEmailboolean

Is two factor login by EMAIL enabled

emailstring

User email

Example response

[
  {
    "userGroups": [
      {
        "contentFilters": [
          {
            "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
            "controlType": "single,picker,slider,range_time_slider",
            "plainControlType": "single,multiple,tree,custom"
          }
        ]
      }
    ],
    "userProperties": {
      "userContentFilters": [
        {
          "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
          "controlType": "single,picker,slider,range_time_slider",
          "plainControlType": "single,multiple,tree,custom"
        }
      ],
      "customerContentFilters": [
        {
          "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
          "controlType": "single,picker,slider,range_time_slider",
          "plainControlType": "single,multiple,tree,custom"
        }
      ],
      "groupContentFilters": [
        {
          "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
          "controlType": "single,picker,slider,range_time_slider",
          "plainControlType": "single,multiple,tree,custom"
        }
      ],
      "sharedContentFilters": [
        {
          "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
          "controlType": "single,picker,slider,range_time_slider",
          "plainControlType": "single,multiple,tree,custom"
        }
      ],
      "contentFilters": [
        {
          "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
          "controlType": "single,picker,slider,range_time_slider",
          "plainControlType": "single,multiple,tree,custom"
        }
      ]
    },
    "selectedDashInternal": {
      "defaultFilterSets": [
        {
          "filters": [
            {
              "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
              "controlType": "single,picker,slider,range_time_slider",
              "plainControlType": "single,multiple,tree,custom"
            }
          ]
        }
      ],
      "properties": {
        "filters": [
          {
            "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
            "controlType": "single,picker,slider,range_time_slider",
            "plainControlType": "single,multiple,tree,custom"
          }
        ],
        "defaultFilters": [
          {
            "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
            "controlType": "single,picker,slider,range_time_slider",
            "plainControlType": "single,multiple,tree,custom"
          }
        ],
        "filterSets": [
          {
            "filters": [
              {
                "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
                "controlType": "single,picker,slider,range_time_slider",
                "plainControlType": "single,multiple,tree,custom"
              }
            ]
          }
        ],
        "defaultFilterSets": [
          {
            "filters": [
              {
                "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
                "controlType": "single,picker,slider,range_time_slider",
                "plainControlType": "single,multiple,tree,custom"
              }
            ]
          }
        ]
      },
      "propertiesInternally": {
        "filters": [
          {
            "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
            "controlType": "single,picker,slider,range_time_slider",
            "plainControlType": "single,multiple,tree,custom"
          }
        ],
        "defaultFilters": [
          {
            "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
            "controlType": "single,picker,slider,range_time_slider",
            "plainControlType": "single,multiple,tree,custom"
          }
        ],
        "filterSets": [
          {
            "filters": [
              {
                "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
                "controlType": "single,picker,slider,range_time_slider",
                "plainControlType": "single,multiple,tree,custom"
              }
            ]
          }
        ],
        "defaultFilterSets": [
          {
            "filters": [
              {
                "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
                "controlType": "single,picker,slider,range_time_slider",
                "plainControlType": "single,multiple,tree,custom"
              }
            ]
          }
        ]
      }
    }
  }
]