Retrieve a list of users

get

/api/REST/2.0/system/security/group/{id}/users

Retrieves a list of users that belong to the specified security group

Request

Supported Media Types
Path Parameters
  • The security group id, from which you want to retrieve users
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultSecurityGroupUser
Type: object
Title: QueryResultSecurityGroupUser
Show Source
Nested Schema : elements
Type: array
Array of security group user data.
Show Source
Nested Schema : SecurityGroupUser
Type: object
Title: SecurityGroupUser
Show Source
Nested Schema : User
Type: object
Title: User
Show Source
Nested Schema : betaAccess
Type: array
A list of strings: beta programs the user can access.
Show Source
Nested Schema : capabilities
Type: array
A list of strings: the user's capabilities.
Show Source
Nested Schema : crmUserNames
Type: object
Title: crmUserNames
Show Source
Nested Schema : interfacePermissions
Type: array
A list of the user's interface permissions.
Show Source
Nested Schema : permissions
Type: array
The permissions for the user granted to your current instance. This is a read-only property.
Show Source
Nested Schema : UserPreferences
Type: object
Title: UserPreferences
Show Source
Nested Schema : productPermissions
Type: array
A list of the user's product permissions.
Show Source
Nested Schema : securityGroups
Type: array
The user's security groups.
Show Source
Nested Schema : shortcuts
Type: array
This parameter is not used.
Show Source
Nested Schema : typePermissions
Type: array
A list of the user's type permissions.
Show Source
Nested Schema : InterfacePermission
Type: object
Title: InterfacePermission
Show Source
Nested Schema : nestedInterfacePermissions
Type: array
Show Source
Nested Schema : ProductPermission
Type: object
Title: ProductPermission
Show Source
Nested Schema : SecurityGroup
Type: object
Title: SecurityGroup
Show Source
Nested Schema : permissions
Type: array
The permissions for the security granted to your current instance.
Show Source
Nested Schema : TypePermission
Type: object
Title: TypePermission
Show Source
Nested Schema : TypePermissions
Type: object
Title: TypePermissions
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve a list of users who belong to a security group, where the security group ID is 1:


GET /api/REST/2.0/system/security/group/1/users
			

Response:

The response returns a list of security group users and their user IDs.


{
  "elements": [
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "2"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "3"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "4"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "6"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "7"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "8"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "9"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "10"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "14"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "17"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "19"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "21"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "22"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "26"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "28"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "29"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "30"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "31"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "32"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "33"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "34"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "35"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "36"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "37"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "38"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "40"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "41"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "42"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "43"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "44"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "45"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "46"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "47"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "48"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "49"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "50"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "51"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "52"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "53"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "54"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "56"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "57"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "59"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "60"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "63"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "64"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "65"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "66"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "67"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "68"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "69"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "70"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "71"
      }
    },
    {
      "type": "SecurityGroupUser",
      "user": {
        "type": "User",
        "id": "72"
      }
    }
  ],
  "page": 1,
  "pageSize": 54,
  "total": 54
}
			
Back to Top