Creates a new user
post
                    /learn.rest/v1/users
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(optional): 
            string
            The city of the user.
- 
            company(optional): 
            string
            The User's place of work.
- 
            country(optional): 
            string
            The country of the user.
- 
            createMembershipResourceForUser(optional): 
            object  MembershipForCreateUserRequest
            
            Object comprising parameters to add users to a membership.
- 
            department(optional): 
            string
            The User's department.
- 
            email(optional): 
            string
            The User's email address.
- 
            email2(optional): 
            string
            The secondary email address.
- 
            employeeId(optional): 
            string
            Email address of the employee.
- 
            fax(optional): 
            string
            The fax number of the user.
- 
            firstName(optional): 
            string
            Description of the user.
- 
            gender(optional): 
            string
            Allowed Values:[ "male", "female" ]User gender. Enum for gender are: male, female
- 
            includeInSearchFlag(optional): 
            boolean
            Default Value:falseWhether the user created should be visible in searches.
- 
            jobTitle(optional): 
            string
            The User's job title.
- 
            lastName(optional): 
            string
            Description of the user.
- 
            managerName(optional): 
            string
            The User's manager's name.
- 
            officeName(optional): 
            string
            The User's office.
- 
            pager(optional): 
            string
            The pager number of the user.
- 
            pagerInteractive(optional): 
            string
            The User's interactive pager number.
- 
            participatesInDaylight(optional): 
            boolean
            Default Value:trueWhether the user's timezone observes daylight savings
- 
            passwordValidUntilDate(optional): 
            string
            The date until which the password is valid.
- 
            phoneDaytime(optional): 
            string
            The day time number of the user.
- 
            phoneEvening(optional): 
            string
            The evening number of the user.
- 
            phoneMobile(optional): 
            string
            The mobile number of the user.
- 
            postalCode(optional): 
            string
            The postal code of the user.
- 
            profession(optional): 
            string
            
- 
            ssn(optional): 
            string
            The user's social security number.
- 
            state(optional): 
            string
            The state of the user.
- 
            street1(optional): 
            string
            The street text address of the user.
- 
            street2(optional): 
            string
            The street text address of the user.
- 
            timeZone(optional): 
            string
            The User's timezone
- 
            username(optional): 
            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: 
            number(int32)
            Unique identifier of the LearnCenter.Example:178409
- 
            status: 
            string
            Enum for membership status are: pending, approved, removed and denied.Example:approved
- 
            validFromDate(optional): 
            string(date-time)
            Date from which the membership is valid.
- 
            validUntilDate(optional): 
            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: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectUser response object.
    
    
    
    
        Show Source
        - 
            count(optional): 
            number
            Count is the current number of records displayed in the response.
- 
            hasMore(optional): 
            boolean
            True indicates that we have more records to be displayed.
- 
            items(optional): 
            array  items
            
            Item object.
- 
            limit(optional): 
            number
            Specify how many items should be returned in a payload. Must be lower than server default limit size.
- 
            links(optional): 
            array  links
            
            Link to the user response.
Example:
    
    
{
    "items":[
        {
            "id":947334,
            "username":"cwallace",
            "nickname":"cw",
            "firstName":"Christopher",
            "lastName":"Wallace",
            "street1":"500 Oracle Parkway",
            "street2":"n/a",
            "city":"Redwood Shores",
            "postalCode":"94065",
            "state":"CA",
            "country":"US",
            "phoneDaytime":"+1.650.506.7000",
            "phoneEvening":"n/a",
            "phoneMobile":"+1.800.392.2999",
            "fax":"n/a",
            "pager":"n/a",
            "pagerInteractive":"n/a",
            "email":"info@oracle.com",
            "email2":"n/a",
            "gender":"male",
            "ssn":"n/a",
            "employeeId":"n/a",
            "company":"Oracle",
            "officeName":"HQ",
            "department":"Product Development",
            "jobTitle":"Product Manager",
            "profession":"Product Management",
            "managerName":"n/a",
            "createdDate":"2011-12-01T14:50:00-05:00",
            "lastAccessedDate":"2011-12-01T14:50:00-05:00",
            "lastUpdatedDate":"2011-12-01T14:50:00-05:00",
            "lastUpdatedByUserId":947334,
            "timeZone":"Eastern Standard Time",
            "participatesInDaylight":true,
            "lastUpdatedByUser":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"{url}/learn.rest/v1/users/{userId}"
                    }
                ]
            },
            "passwordValidUntilDate":"2011-12-10T14:50:00-05:00",
            "includeInSearchFlag":true,
            "memberships":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"{url}/learn.rest/v1/users/{userId}/memberships"
                    }
                ]
            },
            "links":[
                {
                    "rel":"canonical",
                    "href":"{url}/learn.rest/v1/users/{userId}"
                }
            ]
        },
        "..."
    ],
    "totalResults":1200,
    "limit":100,
    "count":100,
    "hasMore":true,
    "links":[
        {
            "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"
        }
    ]
}Nested Schema : items
    
      
      Type: 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    arrayItem object.
    
    
    
    
    
        Show Source
        - 
            Array of: 
                object  User
            
            User response object
Nested Schema : User
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectUser response object
    
    
    
    
        Show Source
        - 
            city(optional): 
            string
            The city of the user.
- 
            company(optional): 
            string
            The User's place of work.
- 
            country(optional): 
            string
            The country of the user.
- 
            createdDate(optional): 
            string(datetime)
            Date the users created.
- 
            department(optional): 
            string
            The User's department.
- 
            email(optional): 
            string
            The User's email address.
- 
            email2(optional): 
            string
            The secondary email address.
- 
            employeeId(optional): 
            string
            Email address of the employee.
- 
            fax(optional): 
            string
            The fax number of the user.
- 
            firstName(optional): 
            string
            Description of the user.
- 
            gender(optional): 
            string
            Allowed Values:[ "male", "female" ]User gender. Enum for gender are: male, female
- 
            id(optional): 
            number
            
- 
            includeInSearchFlag(optional): 
            boolean
            Default Value:falseSpecifies whether the user will be included in searches.
- 
            jobTitle(optional): 
            string
            The User's job title.
- 
            lastAccesedDate(optional): 
            string(datetime)
            The last accessed date of the user record.
- 
            lastName(optional): 
            string
            Description of the user.
- 
            lastUpdatedBy(optional): 
            array  lastUpdatedBy
            
            The person who last updated the user record.
- 
            lastUpdatedByUserId(optional): 
            number
            The user who last updated the user record.
- 
            lastUpdatedDate(optional): 
            string(datetime)
            The last updated date of the user record.
- 
            managerName(optional): 
            string
            The User's manager's name.
- 
            officeName(optional): 
            string
            The User's office.
- 
            pager(optional): 
            string
            The pager number of the user.
- 
            pagerInteractive(optional): 
            string
            The User's interactive pager number.
- 
            participatesInDaylight(optional): 
            boolean
            Default Value:trueSpecifies whether the user's timezone observes daylight savings
- 
            passwordValidUntilDate(optional): 
            string
            Date until which the password is valid for a user.
- 
            phoneDaytime(optional): 
            string
            The day time number of the user.
- 
            phoneEvening(optional): 
            string
            The evening number of the user.
- 
            phoneMobile(optional): 
            string
            The mobile number of the user.
- 
            postalCode(optional): 
            string
            The postal code of the user.
- 
            profession(optional): 
            string
            Profession of the user.
- 
            ssn(optional): 
            string
            The user's social security number.
- 
            state(optional): 
            string
            The state of the user.
- 
            street1(optional): 
            string
            The street text address of the user.
- 
            street2(optional): 
            string
            The street text address of the user.
- 
            timeZone(optional): 
            string
            The user's timezone
- 
            username(optional): 
            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@oracle.com",
    "email2":"abc.def@oracle.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,
    "timeZone":"Eastern Standard Time",
    "participatesInDaylight":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  UserLinkItems
            
            Link to user items.
Nested Schema : UserLinkItems
    
      Type: 
      
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    objectLink to user items.
    
    
    
    
        Show Source
        - 
            href(optional): 
            string
            Example:{url}/learn.rest/v1/users/456
- 
            rel(optional): 
            string
            Example:canonical
Example:
    
    
{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}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.