Create Company User
post
/rest/v16/companies/{companyName}/users
This operation creates a new user.
Request
Supported Media Types
- application/json
Path Parameters
-
companyName(required): string
Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.
Root Schema : User request model
Type:
objectTitle:
User request modelRequest for creating a user
Show Source
-
active:
boolean
Title:
User statusStatus of the User -
emails(required):
array Email
Title:
EmailEmail of the User -
enterpriseUser(required):
object enterpriseUser
-
extensionUser(required):
object extensionUser
-
name(required):
object Name
Title:
NameFull name of the user -
phoneNumbers:
array Phone Numbers
Title:
Phone NumbersPhone numbers of the User -
preferredLanguage:
string
Title:
Preferred LanguagePreferred language of the User -
timezone:
string
Title:
timezoneTime zone of the user -
title:
string
Title:
Job title of the UserJob title of the User -
userName(required):
string
Title:
UsernameLogin Name of the user
Nested Schema : enterpriseUser
Type:
Show Source
object-
organization(required):
string
Title:
OrganizationCompany name of the user
Nested Schema : extensionUser
Type:
Show Source
object-
addresses:
array addresses
-
approvalDelegate:
string
Title:
Approval DelegateApproval Delegate -
currency:
string
Title:
Currency CodePreferred Currency Code of the user -
dateFormat:
integer
Title:
Date Format IdDate Format Id -
enabledForSso:
string
Title:
Enabled For SSOEnabled For SSO -
externalSsoId:
string
Title:
externalSsoIdExternal SSO Id -
fax:
string
Title:
Fax NumberFax of the user -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission EnabledAccess Admin Permission Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference EmailIs Notification Preference Email -
isNotifyFax:
boolean
Title:
Is Notification Preference FaxIs Notification preference Fax -
isProxyPermEnabled:
boolean
Title:
Proxy permission enabledProxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission EnabledIs Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services OnlyWeb Services Only -
numberFormat:
integer
Title:
Number Format IdNumber Format Id -
partnerLogin:
string
Title:
Partner LoginPartner Login of the user -
SeparateShipAddr:
boolean
Title:
Separate ship addressSeparate ship address -
sfdcOrgId:
string
Title:
Sfdc Organization IDSfdc Organization ID -
units:
integer
Title:
UnitsUnits -
userType:
string
Title:
Type of the userType of the user
Nested Schema : Name
Type:
objectTitle:
NameFull name of the user
Show Source
-
familyName:
string
Title:
FamilyNameLast Name of the user -
givenName(required):
string
Title:
GivenNameFirst name of the user
Nested Schema : Phone Numbers
Type:
arrayTitle:
Phone NumbersPhone numbers of the User
Show Source
Nested Schema : email
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether email is primary or not -
type:
string
Title:
typeType of the email -
value(required):
string
Title:
valuevalue of the email
Nested Schema : address
Type:
Show Source
object-
address1:
string
Title:
Shipping/Billing Address 1Shipping/Billing Address 1 -
address2:
string
Title:
Shipping/Billing Address 2Shipping/Billing Address 2 -
companyName:
string
Title:
Shipping/Billing CompanyShipping/Billing Company -
companyName2:
string
Title:
Shipping/Billing Company2Shipping/Billing Company2 -
country:
string
Title:
Shipping/Billing CountryShipping/Billing Country -
email:
string
Title:
Shipping/Billing EmailShipping/Billing Email -
fax:
string
Title:
Shipping/Billing FaxShipping/Billing Fax -
locality:
string
Title:
Shipping/Billing LocalityShipping/Billing Locality -
name:
object Shipping/Billing Full name
Title:
Shipping/Billing Full nameShipping/Billing Full name -
phone:
string
Title:
Shipping/Billing PhoneShipping/Billing Phone -
postalCode:
string
Title:
Shipping/Billing Postal CodeShipping/Billing Postal Code -
region:
string
Title:
Shipping/Billing RegionShipping/Billing Region -
type:
string
Title:
Address TypeAllowed Values:[ "BILL_TO", "SHIP_TO" ]Address Type
Nested Schema : Shipping/Billing Full name
Type:
objectTitle:
Shipping/Billing Full nameShipping/Billing Full name
Show Source
-
familyName:
string
Title:
Shipping/Billing FamilyNameShipping/Billing FamilyName -
givenName:
string
Title:
Shipping/Billing GivenNameShipping/Billing GivenName
Nested Schema : phoneNumber
Type:
Show Source
object-
primary:
boolean
Title:
primaryWhether phone number is primary or not -
type:
string
Title:
typeType of the phone number -
value:
string
Title:
valuevalue of the phone number
Response
Supported Media Types
- application/json
Default Response
Created User details
Root Schema : user
Type:
Show Source
object-
accessPermissions:
object Access Permissions
Title:
Access PermissionsAccess Permissions of a user -
approvalDelegate:
string
Title:
Approval DelegateApproval Delegate -
billAddress1:
string
Title:
Billing Address 1Billing Address 1 -
billAddress2:
string
Title:
Billing Address 2Billing Address 2 -
billCity:
string
Title:
Billing CityBilling City -
billCompany:
string
Title:
Billing CompanyBilling Company -
billCompany2:
string
Title:
Billing Company 2Billing Company 2 -
billCountry:
string
Title:
Billing CountryBilling Country -
billEmail:
string
Title:
Billing EmailBilling Email -
billFax:
string
Title:
Billing FaxBilling Fax -
billFirstName:
string
Title:
Billing First NameBilling First Name -
billLastName:
string
Title:
Billing Last NameBilling Last Name -
billPhone:
string
Title:
Billing PhoneBilling Phone -
billStateProvince:
string
Title:
Billing StateBilling State -
billZip:
string
Title:
Billing ZipBilling Zip -
company:
object Company details
Title:
Company detailsUser Company details. Applicable only for Users Across Companies -
currency:
object Currency
Title:
CurrencyCurrency preference of user. Value holds currency code -
dateAdded:
string
Title:
Date AddedUser creation date -
dateFormat:
object Date Format
Title:
Date FormatUser preferred date time format -
dateModified:
string
Title:
Date ModifiedUser modified date -
email:
string
Title:
EmailEmail of the user -
enabledForSso:
object Enabled For SSO
Title:
Enabled For SSOEnabled For SSO -
externalSsoId:
string
Title:
External SSO IdExternal SSO Id -
fax:
string
Title:
Fax NumberFax of the user -
firstName:
string
Title:
First NameFirst Name of the user -
groups:
object Groups
Title:
GroupsGroups to which the user belongs -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission EnabledAccess Admin Permission Enabled -
isMobileEnabled:
boolean
Title:
Is Mobile EnabledIs Mobile Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference EmailIs notification preference email -
isNotifyFax:
boolean
Title:
Is Notification Preference FaxIs notification preference fax -
isProxyPermEnabled:
boolean
Title:
Proxy Permission EnabledProxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission EnabledIs Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services OnlyWeb Services Only -
jobTitle:
string
Title:
Job TitleJob Title of the user -
language:
object Language
Title:
LanguageLanguage preference of user. Value holds language code -
lastLogin:
string
Title:
Last Login DateUser last loggedin date -
lastName:
string
Title:
Last NameLast Name of the user -
links:
array Links to the related objects
Title:
Links to the related objectsLinks to the related objects -
login:
string
Title:
Login IdLogin Id of the user -
numberFormat:
object Number Format
Title:
Number FormatPreferred number format of user -
partnerLogin:
string
Title:
Partner LoginPartner Login -
phone:
string
Title:
Phone NumberPhone number of the user -
separateShipAddr:
boolean
Title:
Seperate Ship AddressSeperate Ship Address -
shipAddress1:
string
Title:
Shipping Address 1Shipping Address 1 -
shipAddress2:
string
Title:
Shipping Address 2Shipping Address 2 -
shipCity:
string
Title:
Shipping CityShipping City -
shipCompany:
string
Title:
Shipping CompanyShipping Company -
shipCompany2:
string
Title:
Shipping Company 2Shipping Company 2 -
shipCountry:
string
Title:
Shipping CountryShipping Country -
shipEmail:
string
Title:
Shipping EmailShipping Email -
shipFax:
string
Title:
Shipping FaxShipping Fax -
shipFirstName:
string
Title:
Shipping First NameShipping First Name -
shipLastName:
string
Title:
Shipping Last NameShipping Last Name -
shipPhone:
string
Title:
Shipping PhoneShipping Phone -
shipStateProvince:
string
Title:
Shipping StateShipping State -
shipZip:
string
Title:
Shipping ZipShipping Zip -
status:
object Status
Title:
StatusStatus of the user -
timeZone:
object TimeZone of user
Title:
TimeZone of userUser preferred timezone -
type:
object Type
Title:
TypeType of the user -
units:
object Units
Title:
UnitsUser preferred units
Nested Schema : Access Permissions
Type:
objectTitle:
Access PermissionsAccess Permissions of a user
Show Source
Nested Schema : Company details
Type:
objectTitle:
Company detailsUser Company details. Applicable only for Users Across Companies
Show Source
-
loginName:
string
Title:
Company Login NameCompany Login Name -
name:
string
Title:
Company NameCompany Name
Nested Schema : Currency
Type:
objectTitle:
CurrencyCurrency preference of user. Value holds currency code
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Date Format
Type:
objectTitle:
Date FormatUser preferred date time format
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Enabled For SSO
Type:
objectTitle:
Enabled For SSOEnabled For SSO
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Language
Type:
objectTitle:
LanguageLanguage preference of user. Value holds language code
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Links to the related objects
Type:
arrayTitle:
Links to the related objectsLinks to the related objects
Show Source
-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : Number Format
Type:
objectTitle:
Number FormatPreferred number format of user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Status
Type:
objectTitle:
StatusStatus of the user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : TimeZone of user
Type:
objectTitle:
TimeZone of userUser preferred timezone
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Type
Type:
objectTitle:
TypeType of the user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Units
Type:
objectTitle:
UnitsUser preferred units
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : items
Type:
Show Source
array-
Array of:
object Access Permission
Title:
Access PermissionUser access bits information
Nested Schema : Access Permission
Type:
objectTitle:
Access PermissionUser access bits information
Show Source
-
hasAccess:
boolean
Title:
Has AccessBoolean attribute that indicates if a user has access to the restricted entity. -
name:
string
Title:
Restricted Entity NameName of the entity to which access restrictions apply -
type:
string
Title:
TypeType of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder -
variableName:
string
Title:
Restricted Entity Variable NameVariable name of the entity to which access restrictions apply
Nested Schema : items
Type:
Show Source
array-
Array of:
object Group
Title:
GroupUser group information
Nested Schema : Group
Type:
objectTitle:
GroupUser group information
Show Source
-
label:
string
Title:
Group NameGroup name -
type:
string
Title:
Group TypeType of the group -
variableName:
string
Title:
Group Variable NameVariable name of the group
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current objectDefault Value:selfLink Relationship to the current object
Examples
The following example shows how to operation creates a new user by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/companies/_host/users
Request Body Sample
{
"login": "johnsmith",
"firstName": "John",
"lastName": "Smith",
"jobTitle": "Sales Administrator",
"password": "password1234",
"emailPassword": true,
"email": "john.smith@companyemail.com",
"phone": "2346456456",
"fax": "456457657",
"billLastName": "test",
"billCompany": "A",
"billCompany2": "test",
"billAddress1": "Address1",
"billAddress2": "Address2",
"billCity": "City",
"billStateProvince": "Illinois",
"billZip": "23434",
"billCountry": "United States",
"billPhone": "457657657",
"billFax": "657657",
"billEmail": "john.smith@companyemail.com",
"shipFirstName": "Super",
"shipLastName": "User",
"shipCompany": "B",
"shipCompany2": "B",
"shipAddress1": "Address",
"shipAddress2": "Address",
"shipCity": "City",
"shipStateProvince": "California",
"shipZip": "345435",
"shipCountry": "United States",
"shipPhone": "345435",
"shipFax": "235435",
"shipEmail": "john.smith@companyemail.com",
"partnerLogin": null,
"separateShipAddr": false,
"isNotifyEmail": true,
"isNotifyFax": false,
"numberFormat": {
"value": 1,
"displayValue": "####,##"
},
"timeZone": {
"value": "America/Los_Angeles",
"displayValue": "(GMT-8:00 GMT-7:00) Los Angeles"
},
"type": {
"value": "FULL_ACCESS",
"displayValue": "FullAccess"
},
"language": {
"value": "en_US",
"displayValue": "English"
},
"currency": {
"value": "USD",
"displayValue": "US Dollar"
},
"dateFormat": {
"value": 16,
"displayValue": "dd/MM/yyyy h:mm a"
},
"status": {
"value": 1,
"displayValue": "Active"
},
"enabledForSso": {
"value": "SSO_ENABLED",
"displayValue": "Enabled for SSO"
},
"groups": {
"items": [{
"label": "Sales Administrator",
"variableName": "salesAdministrator",
"type": "Sales"
}
]
},
"accessPermissions": {
"items": [{
"name": "Testbed",
"variableName": "testbed",
"hasAccess": true,
"type": "productFamily"
}
]
}
}