Retrieve security groups

get

/api/REST/2.0/system/security/groups

Retrieves a list of security groups in Eloqua.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultSecurityGroup
Type: object
Title: QueryResultSecurityGroup
Show Source
Nested Schema : elements
Type: array
Array of security group fields.
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

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 all security groups in your Eloqua instance:


GET /api/REST/2.0/system/security/groups
			

Response:


{
  "elements": [
    {
      "type": "SecurityGroup",
      "id": "1",
      "createdAt": "1174881600",
      "depth": "minimal",
      "description": "",
      "name": "Everyone",
      "updatedAt": "1174881600"
    },
    {
      "type": "SecurityGroup",
      "id": "8",
      "createdAt": "1208715083",
      "depth": "minimal",
      "description": "",
      "name": "API Users",
      "updatedAt": "1208715083"
    },
	...
  ],
  "page": 1,
  "pageSize": 1000,
  "total": 20
}
			

Retrieve the first security group in your instance at complete depth:


GET /api/REST/2.0/system/security/groups?depth=complete&count=1
			

Response:


{
  "elements": [
    {
      "type": "SecurityGroup",
      "id": "1",
      "createdAt": "1174881600",
      "depth": "complete",
      "name": "Everyone",
      "updatedAt": "1174881600",
      "acronym": "EVRY",
      "isEffective": "true",
      "isReadOnly": "true"
    }
  ],
  "page": 1,
  "pageSize": 1,
  "total": 20
}
			
Back to Top