Jump to

• Request
• Response

Add or remove users from a security group

patch

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

Adds or removes users from a security group.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  The security group id, from which you want to add or remove users

Body ()

Array of users to add or remove from the group

Root Schema : schema

Type: array

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SecurityGroupUser

Type: object

Title: SecurityGroupUser

Show Source

• patchMethod(optional): string
  The patch method to perform
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• user(optional): object User
  Title: User

{
    "title":"SecurityGroupUser",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "patchMethod":{
            "type":"string",
            "description":"The patch method to perform"
        },
        "user":{
            "$ref":"#/definitions/UserRest20",
            "description":"User object"
        }
    }
}

Nested Schema : User

Type: object

Title: User

Show Source

• address1(optional): string
  User's address line 1.
• address2(optional): string
  User's address line 2.
• betaAccess(optional): array betaAccess
  A list of strings: beta programs the user can access.
• capabilities(optional): array capabilities
  A list of strings: the user's capabilities.
• cellPhone(optional): string
  Mobile phone number of the user.
• city(optional): string
  The name of the user's city.
• companyDisplayName(optional): string
  Name of the user's company to be displayed.
• companyUrl(optional): string
  URL of the user's company.
• country(optional): string
  The name of the user's country.
• createdAt(optional): string
  Read Only: true

  The date and time the user was created, expressed in Unix time. This is a read-only property.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the user. This is a read-only property.
• crmUsername(optional): string
  User's identifier in default CRM.
• crmUserNames(optional): object crmUserNames
  Title: crmUserNames
• currentStatus(optional): string
  This property is not used.
• defaultAccountViewId(optional): string
  The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
• defaultContactViewId(optional): string
  The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
• department(optional): string
  Name of the user's department.
• depth(optional): 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. This is a read-only property.
• description(optional): string
  The description of the user.
• digitalSignatureId(optional): string
  Internal id of user's digital signature.
• emailAddress(optional): string
  The user's email address.
• fax(optional): string
  Fax number of the user.
• federationId(optional): string
  The user's Federation Id.
• firstName(optional): string
  The first name of the user.
• folderId(optional): string
  Read Only: true

  The folder id of the folder which contains the user. This is a read-only property.
• id(optional): string
  Read Only: true

  Id of the user. This is a read-only property.
• interfacePermissions(optional): array interfacePermissions
  A list of the user's interface permissions.
• isDeleted(optional): string
  Indicates if the user is deleted.
• isDisabled(optional): string
  Read Only: true

  Indicates if the user is disabled.
• isUsingBrightenTemplate(optional): string
  This parameter is not used.
• jobTitle(optional): string
  Job title of the user.
• lastName(optional): string
  The last name of the user.
• loginName(optional): string
  The user's name used to login. This is a read-only property.
• name(optional): string
  The name of the user. This is a read-only property.
• passwordExpires(optional): string
  Indicates if user's password can expire.
• permissions(optional): array permissions
  The permissions for the user granted to your current instance. This is a read-only property.
• personalMessage(optional): string
  User's personal message.
• personalPhotoId(optional): string
  Internal id of user's personal photo.
• personalUrl(optional): string
  User's personal URL.
• phone(optional): string
  Phone number of the user.
• preferences(optional): object UserPreferences
  Title: UserPreferences
• productPermissions(optional): array productPermissions
  A list of the user's product permissions.
• replyToAddress(optional): string
  User's email address used as "reply to" address.
• scheduledFor(optional): string
  Read Only: true

  This parameter is not used.
• securityGroups(optional): array securityGroups
  The user's security groups.
• senderDisplayName(optional): string
  User's "Sender Display Name"
• senderEmailAddress(optional): string
  User's "Sender Email Address"
• sendWelcomeEmail(optional): string
  Indicates if "User Welcome" email would be sent to user upon user creation.
• shortcuts(optional): array shortcuts
  This parameter is not used.
• sourceTemplateId(optional): string
  Id of template used to create the user.
• ssoOnly(optional): string
  Indicates if the user can only login using Single Sign On.
• state(optional): string
  The name of the user's state or province.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• typePermissions(optional): array typePermissions
  A list of the user's type permissions.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the user was last updated. This is a read-only property.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the user. This is a read-only property.
• zipCode(optional): string
  User's ZIP or postal code.

{
    "title":"User",
    "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 user. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used."
        },
        "name":{
            "type":"string",
            "description":"The name of the user. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the user."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the user granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the user. This is a read-only property."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of template used to create the user."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the user. This is a read-only property."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the user. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This parameter is not used."
        },
        "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>. This is a read-only property."
        },
        "loginName":{
            "type":"string",
            "description":"The user's name used to login. This is a read-only property."
        },
        "emailAddress":{
            "type":"string",
            "description":"The user's email address."
        },
        "federationId":{
            "type":"string",
            "description":"The user's Federation Id."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the user."
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the user."
        },
        "preferences":{
            "$ref":"#/definitions/UserPreferencesRest20",
            "description":"A list of user preferences."
        },
        "typePermissions":{
            "type":"array",
            "description":"A list of the user's type permissions.",
            "items":{
                "$ref":"#/definitions/TypePermissionRest20"
            }
        },
        "capabilities":{
            "type":"array",
            "description":"A list of strings: the user's capabilities.",
            "items":{
                "type":"string"
            }
        },
        "betaAccess":{
            "type":"array",
            "description":"A list of strings: beta programs the user can access.",
            "items":{
                "type":"string"
            }
        },
        "defaultContactViewId":{
            "type":"string",
            "description":"The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request."
        },
        "defaultAccountViewId":{
            "type":"string",
            "description":"The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request."
        },
        "securityGroups":{
            "type":"array",
            "description":"The user's security groups.",
            "items":{
                "$ref":"#/definitions/SecurityGroupRest20"
            }
        },
        "interfacePermissions":{
            "type":"array",
            "description":"A list of the user's interface permissions.",
            "items":{
                "$ref":"#/definitions/InterfacePermissionRest20"
            }
        },
        "productPermissions":{
            "type":"array",
            "description":"A list of the user's product permissions.",
            "items":{
                "$ref":"#/definitions/ProductPermissionRest20"
            }
        },
        "isUsingBrightenTemplate":{
            "type":"string",
            "description":"This parameter is not used."
        },
        "shortcuts":{
            "type":"array",
            "description":"This parameter is not used.",
            "items":{
                "type":"string"
            }
        },
        "isDeleted":{
            "type":"string",
            "description":"Indicates if the user is deleted."
        },
        "isDisabled":{
            "type":"string",
            "readOnly":true,
            "description":"Indicates if the user is disabled."
        },
        "jobTitle":{
            "type":"string",
            "description":"Job title of the user."
        },
        "companyDisplayName":{
            "type":"string",
            "description":"Name of the user's company to be displayed."
        },
        "companyUrl":{
            "type":"string",
            "description":"URL of the user's company."
        },
        "phone":{
            "type":"string",
            "description":"Phone number of the user."
        },
        "crmUsername":{
            "type":"string",
            "description":"User's identifier in default CRM."
        },
        "crmUserNames":{
            "$ref":"#/definitions/crmUserNamesRest20",
            "description":"List of <code>CrmUsernames</code> records. User's identifiers in internally supported CRMs."
        },
        "passwordExpires":{
            "type":"string",
            "description":"Indicates if user's password can expire."
        },
        "sendWelcomeEmail":{
            "type":"string",
            "description":"Indicates if \"User Welcome\" email would be sent to user upon user creation."
        },
        "cellPhone":{
            "type":"string",
            "description":"Mobile phone number of the user."
        },
        "address1":{
            "type":"string",
            "description":"User's address line 1."
        },
        "address2":{
            "type":"string",
            "description":"User's address line 2."
        },
        "replyToAddress":{
            "type":"string",
            "description":"User's email address used as \"reply to\" address."
        },
        "department":{
            "type":"string",
            "description":"Name of the user's department."
        },
        "fax":{
            "type":"string",
            "description":"Fax number of the user."
        },
        "personalUrl":{
            "type":"string",
            "description":"User's personal URL."
        },
        "personalMessage":{
            "type":"string",
            "description":"User's personal message."
        },
        "ssoOnly":{
            "type":"string",
            "description":"Indicates if the user can only login using Single Sign On."
        },
        "digitalSignatureId":{
            "type":"string",
            "description":"Internal id of user's digital signature."
        },
        "personalPhotoId":{
            "type":"string",
            "description":"Internal id of user's personal photo."
        },
        "city":{
            "type":"string",
            "description":"The name of the user's city."
        },
        "state":{
            "type":"string",
            "description":"The name of the user's state or province."
        },
        "country":{
            "type":"string",
            "description":"The name of the user's country."
        },
        "zipCode":{
            "type":"string",
            "description":"User's ZIP or postal code."
        },
        "senderEmailAddress":{
            "type":"string",
            "description":"User's \"Sender Email Address\""
        },
        "senderDisplayName":{
            "type":"string",
            "description":"User's \"Sender Display Name\""
        }
    }
}

Nested Schema : betaAccess

Type: array

A list of strings: beta programs the user can access.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of strings: beta programs the user can access.",
    "items":{
        "type":"string"
    }
}

Nested Schema : capabilities

Type: array

A list of strings: the user's capabilities.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of strings: the user's capabilities.",
    "items":{
        "type":"string"
    }
}

Nested Schema : crmUserNames

Type: object

Title: crmUserNames

Show Source

• MSDUserName(optional): string
• OSCUserName(optional): string
• SFDCUserName(optional): string
• SODUserName(optional): string
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"crmUserNames",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "SFDCUserName":{
            "type":"string",
            "description":""
        },
        "MSDUserName":{
            "type":"string",
            "description":""
        },
        "OSCUserName":{
            "type":"string",
            "description":""
        },
        "SODUserName":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : interfacePermissions

Type: array

A list of the user's interface permissions.

Show Source

• Array of: object InterfacePermission
  Title: InterfacePermission

{
    "type":"array",
    "description":"A list of the user's interface permissions.",
    "items":{
        "$ref":"#/definitions/InterfacePermissionRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the user granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the user granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : UserPreferences

Type: object

Title: UserPreferences

Show Source

• timezoneId(optional): string
  The ID of the user's timezone in Eloqua.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"UserPreferences",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID of the user's timezone in Eloqua."
        }
    }
}

Nested Schema : productPermissions

Type: array

A list of the user's product permissions.

Show Source

• Array of: object ProductPermission
  Title: ProductPermission

{
    "type":"array",
    "description":"A list of the user's product permissions.",
    "items":{
        "$ref":"#/definitions/ProductPermissionRest20"
    }
}

Nested Schema : securityGroups

Type: array

The user's security groups.

Show Source

• Array of: object SecurityGroup
  Title: SecurityGroup

{
    "type":"array",
    "description":"The user's security groups.",
    "items":{
        "$ref":"#/definitions/SecurityGroupRest20"
    }
}

Nested Schema : shortcuts

Type: array

This parameter is not used.

Show Source

• Array of: string

{
    "type":"array",
    "description":"This parameter is not used.",
    "items":{
        "type":"string"
    }
}

Nested Schema : typePermissions

Type: array

A list of the user's type permissions.

Show Source

• Array of: object TypePermission
  Title: TypePermission

{
    "type":"array",
    "description":"A list of the user's type permissions.",
    "items":{
        "$ref":"#/definitions/TypePermissionRest20"
    }
}

Nested Schema : InterfacePermission

Type: object

Title: InterfacePermission

Show Source

• interfaceCode(optional): string
• name(optional): string
• nestedInterfacePermissions(optional): array nestedInterfacePermissions
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"InterfacePermission",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "interfaceCode":{
            "type":"string",
            "description":""
        },
        "nestedInterfacePermissions":{
            "type":"array",
            "description":"",
            "items":{
                "$ref":"#/definitions/InterfacePermissionRest20"
            }
        },
        "name":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : nestedInterfacePermissions

Type: array

Show Source

• Array of: object InterfacePermission
  Title: InterfacePermission

{
    "type":"array",
    "description":"",
    "items":{
        "$ref":"#/definitions/InterfacePermissionRest20"
    }
}

Nested Schema : ProductPermission

Type: object

Title: ProductPermission

Show Source

• productCode(optional): string
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"ProductPermission",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "productCode":{
            "type":"string",
            "description":""
        }
    }
}

Nested Schema : SecurityGroup

Type: object

Title: SecurityGroup

Show Source

• acronym(optional): string
  Acronym for the security group
• createdAt(optional): string
  Read Only: true

  The date and time the security group was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the security group.
• depth(optional): 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(optional): string
  The description of the security group.
• id(optional): string
  Read Only: true

  Id of the security group.
• isEffective(optional): string
  Read Only: true

  Indicates if the security group is effective.
• isReadOnly(optional): string
  Read Only: true

  Indicates if the security group is read only.
• name(optional): string
  The name of the security group.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the security group was last updated. This is a read-only property.
• updatedBy(optional): 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."
        }
    }
}

Nested Schema : TypePermission

Type: object

Title: TypePermission

Show Source

• objectType(optional): string
• permissions(optional): object TypePermissions
  Title: TypePermissions
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"TypePermission",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "objectType":{
            "type":"string",
            "description":""
        },
        "permissions":{
            "$ref":"#/definitions/TypePermissionsRest20",
            "description":""
        }
    }
}

Nested Schema : TypePermissions

Type: object

Title: TypePermissions

Show Source

• type(optional): string
  The asset's type in Eloqua. This is a read-only property.

{
    "title":"TypePermissions",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        }
    }
}

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