Creates a new user
post
/learn.rest/v1/users
Creates a new user.
Providing createMembershipResource for a User object is optional. if we provide this, you can create a membership for a newly created user in this post request.
Request
Supported Media Types
- application/json
User object that needs to be created.
Root Schema : CreateUserRequest
Type:
objectObject comprising the user parameters and the membership parameters to create a new user and to add a membership.
Show Source
-
city:
string
The city of the user.
-
company:
string
The User's place of work.
-
country:
string
The country of the user.
-
createMembershipResourceForUser:
object MembershipForCreateUserRequest
Object comprising parameters to add users to a membership.
-
department:
string
The User's department.
-
email:
string
The User's email address.
-
email2:
string
The secondary email address.
-
employeeId:
string
Email address of the employee.
-
fax:
string
The fax number of the user.
-
firstName:
string
Description of the user.
-
gender:
string
Allowed Values:
[ "male", "female" ]User gender. Enum for gender are: male, female -
includeInSearchFlag:
boolean
Default Value:
falseWhether the user created should be visible in searches. -
jobTitle:
string
The User's job title.
-
lastName:
string
Description of the user.
-
managerName:
string
The User's manager's name.
-
officeName:
string
The User's office.
-
pager:
string
The pager number of the user.
-
pagerInteractive:
string
The User's interactive pager number.
-
participatesInDaylight:
boolean
Default Value:
trueWhether the user's timezone observes daylight savings -
passwordValidUntilDate:
string
The date until which the password is valid.
-
phoneDaytime:
string
The day time number of the user.
-
phoneEvening:
string
The evening number of the user.
-
phoneMobile:
string
The mobile number of the user.
-
postalCode:
string
The postal code of the user.
-
profession:
string
-
ssn:
string
The user's social security number.
-
state:
string
The state of the user.
-
street1:
string
The street text address of the user.
-
street2:
string
The street text address of the user.
-
timeZone:
string
The User's timezone
-
username:
string
Username of the user
Example:
{
"username":"cwallace",
"firstName":"Chris",
"lastName":"Wallace",
"street1":"500 Oracle Parkway",
"street2":"suite 500",
"city":"Redwood Shores",
"state":"CA",
"postalCode":"94065",
"country":"US",
"officeName":"HQ",
"gender":"male",
"includeInSearchFlag":true,
"jobTitle":"Product Manager",
"managerName":"n/a",
"pagerInteractive":"n/a",
"ssn":"n/a",
"email2":"n/a",
"pager":"n/a",
"company":"Oracle",
"fax":"n/a",
"department":"Product Development",
"phoneEvening":"n/a",
"email":"info@oracle.com",
"phoneDaytime":"+1.650.506.7000",
"profession":"Product Management",
"phoneMobile":"+1.800.392.2999",
"employeeId":"n/a",
"passwordValidUntilDate":"2016-10-12T11:00:00-04:00",
"timeZone":"Eastern Standard Time",
"participatesInDaylight":true,
"createMembershipResourceForUser":{
"learncenterId":"178409",
"status":"Approved",
"validFromDate":"2019-03-04T11:00:00-04:00",
"validUntilDate":"2019-03-09T11:00:00-05:00"
}
}Nested Schema : MembershipForCreateUserRequest
Type:
objectObject comprising parameters to add users to a membership.
Show Source
-
learncenterId(required):
number(int32)
Unique identifier of the LearnCenter.Example:
178409 -
status(required):
string
Enum for membership status are: pending, approved, removed and denied.Example:
approved -
validFromDate:
string(date-time)
Date from which the membership is valid.
-
validUntilDate:
string(date-time)
Date till which the membership is until.
Example:
{
"learncenterId":"178409",
"status":"approved",
"validFromDate":"2019-03-04T11:00::00-04:00",
"validUntilDate":"2019-03-09T11:00:00-05:00"
}Security
-
auth: basic
Type:
basicDescription:Basic Authentication
Response
Supported Media Types
- application/xml
- application/json
201 Response
New user created.
Root Schema : UsersResponse
Type:
Show Source
object-
count:
number
Example:
100 -
hasMore:
boolean
Example:
true -
items:
array items
-
limit:
number
Example:
100 -
links:
array links
Nested Schema : User
Type:
objectResponse object of the users.
Show Source
-
certificationExpirationDate:
string(date)
Expiration of the certification.
-
city:
string
The city of the user.
-
company:
string
The User's place of work.
-
country:
string
The country of the user.
-
createdDate:
string(datetime)
Date the users created.
-
department:
string
The User's department.
-
email:
string
The User???s email address.
-
email2:
string
The secondary email address.
-
employeeId:
string
Email address of the employee.
-
fax:
string
The fax number of the user.
-
firstName:
string
Description of the user.
-
gender:
string
Allowed Values:
[ "male", "female" ]User gender. Enum for gender are: male, female -
hireDate:
string(date)
The hire date of the user.
-
id:
number
User id.
-
includeInSearchFlag:
boolean
Default Value:
falseInclude the user in a search. -
jobTitle:
string
The User's job title.
-
lastAccesedDate:
string(datetime)
The last accessed date of the user record.
-
lastHireDate:
string(date)
The last hire date for the user.
-
lastJobChangeDate:
string(date)
The last date when the user changed jobs.
-
lastName:
string
Description of the user.
-
lastUpdatedBy:
array lastUpdatedBy
The person who last updated the user record.
-
lastUpdatedByUserId:
number
The user who last updated the user record.
-
lastUpdatedDate:
string(datetime)
The last updated date of the user record.
-
links:
object UserLinkItem
Object of the User Link Item.
-
managerName:
string
The User's manager's name.
-
memberships:
object MembershipLinkItem
Link to a Membership item.
-
officeName:
string
The User's office.
-
pager:
string
The pager number of the user.
-
pagerInteractive:
string
The User's interactive pager number.
-
phoneDaytime:
string
-
phoneEvening:
string
The day time number of the user.
-
phoneMobile:
string
The mobile number of the user.
-
postalCode:
string
The postal code of the user.
-
profession:
string
-
ssn:
string
The user's social security number.
-
state:
string
The state of the user.
-
street1:
string
The street text address of the user.
-
street2:
string
The street text address of the user.
-
username:
string
Username of the user.
Example:
{
"id":112870,
"username":"abc",
"nickname":"",
"firstName":"abc",
"lastName":"def",
"street1":"4500 Oracle Ln",
"street2":"Suite 400",
"city":"Redwood Shores",
"postalCode":"94566",
"state":"CA",
"country":"US",
"phoneDaytime":"614.266.2084Ex.0000",
"phoneEvening":"614-638-5648",
"phoneMobile":"614.266.2084",
"fax":"",
"pager":"",
"pagerInteractive":"",
"email":"abc.def@example.com",
"email2":"abc.def@example.com",
"gender":"male",
"ssn":"",
"employeeId":"Test EEID for abc",
"company":"Oracle",
"officeName":"",
"department":"",
"jobTitle":"Job Manager",
"profession":"",
"managerName":"",
"createdDate":"2011-12-01T16:36:00-05:00",
"lastAccessedDate":"2018-12-20T12:08:00-05:00",
"lastUpdatedDate":"2018-10-08T10:48:31-04:00",
"lastUpdatedByUserId":112870,
"lastUpdatedBy":{
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/112870"
}
]
},
"hireDate":"2018-06-03T00:00:00",
"lastHireDate":"2007-04-11T00:00:00",
"lastJobChangeDate":"2012-07-02T00:00:00",
"certificationExpirationDate":"2017-11-17T00:00:00",
"includeInSearchFlag":true,
"memberships":{
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/112870/memberships"
}
]
},
"links":[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/112870"
}
]
}Nested Schema : lastUpdatedBy
Type:
arrayThe person who last updated the user record.
Show Source
-
Array of:
object UserLinkItem
Object of the User Link Item.
Nested Schema : UserLinkItem
Type:
objectObject of the User Link Item.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/users/456 -
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}Nested Schema : MembershipLinkItem
Type:
objectLink to a Membership item.
Show Source
-
href:
string
Example:
{url}/learn.rest/v1/memberships/456 -
rel:
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/memberships/456"
}Nested Schema : items
Type:
Show Source
objectExample:
[
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users"
},
{
"rel":"first",
"href":"{url}/v1/users?limit=100&offset=0"
},
{
"rel":"prev",
"href":"{url}/learn.rest/v1/users?limit=100&offset=0"
},
{
"rel":"next",
"href":"{url}/learn.rest/v1/users?limit=100&offset=10"
},
{
"rel":"last",
"href":"{url}/learn.rest/v1/users?limit=100&offset=1200"
}
]400 Response
Request has incorrect syntax or does not contain a field that is required.
409 Response
Another resource with the same identifier already exists.
500 Response
Internal server error.