Retrieve security groups
get
/api/rest/2.0/system/security/groups
Retrieves a list of security groups in Eloqua.
Request
Supported Media Types
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. The default value isminimal
. -
lastUpdatedAt: integer
The date and time the security group was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
page: integer
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultSecurityGroup
Type:
object
Title:
Show Source
QueryResultSecurityGroup
-
elements:
array elements
Array of security group fields.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of security group fields.
Show Source
-
Array of:
object SecurityGroup
Title:
SecurityGroup
Nested Schema : SecurityGroup
Type:
object
Title:
Show Source
SecurityGroup
-
acronym:
string
Acronym for the security group
-
createdAt:
string
Read Only:
true
The date and time the security group was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the security group. -
createdByName:
string
The name of the user who created the security group.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the security group.
-
id:
string
Read Only:
true
Id of the security group. -
isEffective:
string
Read Only:
true
Indicates if the security group is effective. -
isReadOnly:
string
Read Only:
true
Indicates if the security group is read only. -
name:
string
The name of the security group.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the security group was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the security group. This is a read-only property. -
updatedByName:
string
The name of the user who last updated the security group.
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.
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
}