User Accounts
userAccounts Based on latest (2026.09)
Create, change, delete and look up User Accounts, with user account roles. Actions include autoprovision roles and reset password.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE3 actions
- Record key
GUID- Required on create
- none marked
- At a glance
- 11 fields1 finders1 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/userAccounts?fields=CreatedBy,CreationDate,CredentialsEmailSentFlag,GUID,LastUpdateDate&limit=25&onlyData=true
{
"items": [
{
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CredentialsEmailSentFlag": false,
"GUID": "<string, max 64>",
"LastUpdateDate": "2026-01-31T09:00:00+00:00"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 11
| Attribute | Type | Use |
|---|---|---|
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CredentialsEmailSentFlag | yes/no · max 30 · default false | Optional on createUpdatableSearchable |
GUID | text · max 64 | Optional on createSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
PersonId | number | Optional on createUpdatableSearchable |
PersonNumber | text · max 30 | Optional on createUpdatableSearchable |
SuspendedFlag | yes/no · max 30 | Optional on createUpdatableSearchable |
UserId | number | Optional on createSearchable |
Username | text · max 100 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByFinder·GUID
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/<name>. Add them to a GET with expand.
userAccountRolesGET · POST · DELETE User Account Roles · 7 fields · 1 findersCreatedByCreationDateLastUpdateDateLastUpdatedByRoleCodeRoleIdUserRoleId
Actions 3
POST …/{GUID}/action/autoprovisionRoles·processImmediateFlagPOST …/{GUID}/action/resetPasswordPOST …/{GUID}/action/updatePassword·pwd
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/userAccountsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:CredentialsEmailSentFlag, notcredentialsemailsentflag. - 4 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.