openapi: 3.2.0 info: title: REST API for Oracle Eloqua Marketing Cloud Service Application/2.0/Users API description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. version: 2026.08.07 x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers. tags: - name: Application/2.0/Users description: Users API endpoints. paths: /api/rest/2.0/system/user: post: operationId: CreateIndividualPOSTRest20 summary: Create a user description: Creates a new user. responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/UserRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '409': description: Conflict '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-post x-filename-id: api-rest-2.0-system-user-post requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRest20' description: The request body defines the details of the user to be created. required: true /api/rest/2.0/system/user/{id}: get: operationId: ReadIndividualGETRest20 parameters: - name: id in: path description: The user ID to retrieve required: true schema: type: integer - name: depth in: query description: '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.' required: false schema: type: string summary: Retrieve a user description: Retrieves the user specified by the id parameter. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-{id}-get x-filename-id: api-rest-2.0-system-user-id-get put: operationId: UpdateIndividualPUTRest20 parameters: - name: id in: path description: The ID of the user to update required: true schema: type: integer summary: Update a user description: Updates the user specified by the id parameter. Users without the "ManageUsers" action permission can only update their own user account. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-{id}-put x-filename-id: api-rest-2.0-system-user-id-put requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRest20' description: The request body defines the details of the user to be updated required: true delete: operationId: DeleteIndividualDELETERest20 parameters: - name: id in: path description: The user ID to delete required: true schema: type: integer summary: Delete a user description: Deletes a user responses: '200': description: OK '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-{id}-delete x-filename-id: api-rest-2.0-system-user-id-delete /api/rest/2.0/system/user/current: get: operationId: GetCurrentUserGETRest20 parameters: - name: depth in: query description: '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.' required: false schema: type: string summary: Retrieve the current user description: Retrieves the current user performing the request. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-current-get x-filename-id: api-rest-2.0-system-user-current-get /api/rest/2.0/system/user/{id}/password: put: operationId: UpdatePasswordPUTRest20 parameters: - name: id in: path description: The id of the user to update the password required: true schema: type: integer summary: Update a user's password description: Updates a user's password. responses: '200': description: OK '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-{id}-password-put x-filename-id: api-rest-2.0-system-user-id-password-put requestBody: content: application/json: schema: $ref: '#/components/schemas/UserPasswordRest20' description: The request body defines the details of the request required: true /api/rest/2.0/system/user/{id}/enabled: put: operationId: UpdateEnabledPUTRest20 parameters: - name: id in: path description: The ID of the user to enable or disable required: true schema: type: integer summary: Enable or disable a user description: Enables or disables the user's account specified by the id parameter. Users without the "ManageUsers" action permission can only enable or disable their own account. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserEnabledRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-user-{id}-enabled-put x-filename-id: api-rest-2.0-system-user-id-enabled-put requestBody: content: application/json: schema: $ref: '#/components/schemas/UserEnabledRest20' description: The request body defines whether to enable or disable the user with the specified ID required: true /api/rest/2.0/system/users: get: operationId: SearchGETRest20 parameters: - name: depth in: query description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. The default value is minimal.' required: false schema: type: string - name: count in: query description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1. required: false schema: type: integer - name: page in: query description: 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. required: false schema: type: integer - name: search in: query description: Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter. required: false schema: type: string - name: orderBy in: query description: Specifies the field by which list results are ordered. required: false schema: type: string - name: lastUpdatedAt in: query description: The date and time the user was last updated. required: false schema: type: integer summary: Retrieve a list of users description: Retrieves all users that match the criteria specified by the request parameters. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/QueryResultUserRest20' '400': description: Bad request. See Status Codes for information about other possible HTTP status codes. '401': description: Unauthorized. See Status Codes for information about other possible HTTP status codes. '403': description: Forbidden. See Status Codes for information about other possible HTTP status codes. '404': description: The requested resource was not found. See Status Codes for information about other possible HTTP status codes. '500': description: The service has encountered an error. See Status Codes for information about other possible HTTP status codes. tags: - Application/2.0/Users x-internal-id: api-rest-2.0-system-users-get x-filename-id: api-rest-2.0-system-users-get components: schemas: UserEnabledRest20: title: UserEnabled properties: type: type: string description: The asset's type in Eloqua. This is a read-only property. enabled: type: string description: Whether or not the user's account is enabled or disabled. Set {\"enabled\":true} to enable a user, otherwise {\"enabled\":false}. QueryResultUserRest20: title: QueryResultUser properties: type: type: string description: The asset's type in Eloqua. elements: type: array description: Array of user fields. items: $ref: '#/components/schemas/UserRest20' total: type: integer description: The total amount of results. pageSize: type: integer description: The page size. page: type: integer description: The specified page. TypePermissionsRest20: title: TypePermissions properties: type: type: string description: The asset's type in Eloqua. This is a read-only property. InterfacePermissionRest20: 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: '#/components/schemas/InterfacePermissionRest20' name: type: string description: '' ProductPermissionRest20: title: ProductPermission properties: type: type: string description: The asset's type in Eloqua. This is a read-only property. productCode: type: string description: '' TypePermissionRest20: 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: '#/components/schemas/TypePermissionsRest20' description: '' UserPasswordRest20: title: UserPassword properties: type: type: string description: The asset's type in Eloqua. This is a read-only property. password: type: string description: The user's password. mustChangePassword: type: string description: Boolean to determine whether the user must change their password upon logging in. crmUserNamesRest20: 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: '' SODUserName: type: string description: '' UserRest20: 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. createdByName: type: string description: The name of the user who created the user. 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. updatedByName: type: string description: The name of the user who last updated the user. 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: 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.' 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: '#/components/schemas/UserPreferencesRest20' description: A list of user preferences. typePermissions: type: array description: A list of the user's type permissions. items: $ref: '#/components/schemas/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: '#/components/schemas/SecurityGroupRest20' interfacePermissions: type: array description: A list of the user's interface permissions. items: $ref: '#/components/schemas/InterfacePermissionRest20' productPermissions: type: array description: A list of the user's product permissions. items: $ref: '#/components/schemas/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: '#/components/schemas/crmUserNamesRest20' description: List of CrmUsernames 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" isAssetManager: type: string description: User_Field_IsAssetManager_Description UserPreferencesRest20: 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. SecurityGroupRest20: 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. createdByName: type: string description: The name 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. updatedByName: type: string description: The name of the user who last updated the security group. 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: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.' 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.