Jump to

• Request
• Response

Create a security group

post

/api/rest/2.0/system/security/group

Creates a new security group.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the security group to be created.

Root Schema : SecurityGroup

Type: object

Title: SecurityGroup

Show Source

• 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.
• 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, and complete. Any other values passed are reset to complete 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.

{
    "title":"SecurityGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the security group."
        },
        "description":{
            "type":"string",
            "description":"The description of the security group."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the security group."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the security group was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the security group. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the security group was last updated. This is a read-only property."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "name":{
            "type":"string",
            "description":"The name of the security group."
        },
        "acronym":{
            "type":"string",
            "description":"Acronym for the security group"
        },
        "isReadOnly":{
            "type":"string",
            "readOnly":true,
            "description":"Indicates if the security group is read only."
        },
        "isEffective":{
            "type":"string",
            "readOnly":true,
            "description":"Indicates if the security group is effective."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success

Body ()

Root Schema : SecurityGroup

Type: object

Title: SecurityGroup

Show Source

• 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.
• 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, and complete. Any other values passed are reset to complete 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.

{
    "title":"SecurityGroup",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the security group."
        },
        "description":{
            "type":"string",
            "description":"The description of the security group."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the security group."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the security group was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the security group. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the security group was last updated. This is a read-only property."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "name":{
            "type":"string",
            "description":"The name of the security group."
        },
        "acronym":{
            "type":"string",
            "description":"Acronym for the security group"
        },
        "isReadOnly":{
            "type":"string",
            "readOnly":true,
            "description":"Indicates if the security group is read only."
        },
        "isEffective":{
            "type":"string",
            "readOnly":true,
            "description":"Indicates if the security group is effective."
        }
    }
}

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