Jump to

• Request
• Response

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

Body ()

User object that needs to be created.

Root Schema : CreateUserRequest

Type: object

Object 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: false

  Whether 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: true

  Whether 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

{
    "type":"object",
    "description":"Object comprising the user parameters and the membership parameters to create a new user and to add a membership.",
    "properties":{
        "username":{
            "type":"string",
            "description":"Username of the user"
        },
        "firstName":{
            "type":"string",
            "description":"Description of the user."
        },
        "lastName":{
            "type":"string",
            "description":"Description of the user."
        },
        "street1":{
            "type":"string",
            "description":"The street text address of the user."
        },
        "street2":{
            "type":"string",
            "description":"The street text address of the user."
        },
        "city":{
            "type":"string",
            "description":"The city of the user."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code of the user."
        },
        "state":{
            "type":"string",
            "description":"The state of the user."
        },
        "country":{
            "type":"string",
            "description":"The country of the user."
        },
        "phoneDaytime":{
            "type":"string",
            "description":"The day time number of the user."
        },
        "phoneEvening":{
            "type":"string",
            "description":"The evening number of the user."
        },
        "phoneMobile":{
            "type":"string",
            "description":"The mobile number of the user."
        },
        "fax":{
            "type":"string",
            "description":"The fax number of the user."
        },
        "pager":{
            "type":"string",
            "description":"The pager number of the user."
        },
        "pagerInteractive":{
            "type":"string",
            "description":"The User's interactive pager number."
        },
        "email":{
            "type":"string",
            "description":"The User's email address."
        },
        "email2":{
            "type":"string",
            "description":"The secondary email address."
        },
        "gender":{
            "type":"string",
            "description":"User gender. Enum for gender are: male, female",
            "enum":[
                "male",
                "female"
            ]
        },
        "ssn":{
            "type":"string",
            "description":"The user's social security number."
        },
        "employeeId":{
            "type":"string",
            "description":"Email address of the employee."
        },
        "company":{
            "type":"string",
            "description":"The User's place of work."
        },
        "officeName":{
            "type":"string",
            "description":"The User's office."
        },
        "department":{
            "type":"string",
            "description":"The User's department."
        },
        "jobTitle":{
            "type":"string",
            "description":"The User's job title."
        },
        "profession":{
            "type":"string"
        },
        "managerName":{
            "type":"string",
            "description":"The User's manager's name."
        },
        "passwordValidUntilDate":{
            "type":"string",
            "description":"The date until which the password is valid."
        },
        "includeInSearchFlag":{
            "type":"boolean",
            "default":false,
            "description":"Whether the user created should be visible in searches."
        },
        "timeZone":{
            "type":"string",
            "description":"The User's timezone"
        },
        "participatesInDaylight":{
            "type":"boolean",
            "default":true,
            "description":"Whether the user's timezone observes daylight savings"
        },
        "createMembershipResourceForUser":{
            "$ref":"#/definitions/MembershipForCreateUserRequest"
        }
    },
    "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":"[e-mail]",
        "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"
        }
    }
}

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":"[e-mail]",
    "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: object

Object 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.

{
    "type":"object",
    "description":"Object comprising parameters to add users to a membership.",
    "required":[
        "learncenterId",
        "status"
    ],
    "properties":{
        "learncenterId":{
            "type":"number",
            "format":"int32",
            "example":178409,
            "description":"Unique identifier of the LearnCenter."
        },
        "status":{
            "type":"string",
            "description":"Enum for membership status are: pending, approved, removed and denied.",
            "example":"approved"
        },
        "validFromDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date from which the membership is valid."
        },
        "validUntilDate":{
            "type":"string",
            "format":"date-time",
            "description":"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"
    }
}

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: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

New user created.

Body ()

Root Schema : UsersResponse

Type: object

Show Source

• count(optional): number
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): number
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleUserResponse"
            }
        },
        "limit":{
            "type":"number"
        },
        "count":{
            "type":"number"
        },
        "hasMore":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "id":628706,
                "roleId":640,
                "user":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/users/628706"
                        }
                    ]
                },
                "userRole":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640"
                        }
                    ]
                },
                "statusFlag":true,
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users/628706"
                    }
                ]
            },
            {
                "...":null
            }
        ],
        "limit":100,
        "count":100,
        "hasMore":true,
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "id":628706,
            "roleId":640,
            "user":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/users/628706"
                    }
                ]
            },
            "userRole":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640"
                    }
                ]
            },
            "statusFlag":true,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users/628706"
                }
            ]
        },
        {
            "...":null
        }
    ],
    "limit":100,
    "count":100,
    "hasMore":true,
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object UserRoleUserResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRoleUserResponse"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : UserRoleUserResponse

Type: object

Show Source

• createdDate(optional): string
  Example: 2019-02-04T10:46:21Z
• links(optional): array links
• roleId(optional): number
  Example: 640
• statusFlag(optional): boolean
  Example: true
• user(optional): object user
• userId(optional): number
  Example: 123123
• userRole(optional): object userRole

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"number",
            "example":123123
        },
        "roleId":{
            "type":"number",
            "example":640
        },
        "user":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLinkItem"
                    }
                }
            }
        },
        "userRole":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserRoleLinkItem"
                    }
                }
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2019-02-04T10:46:21Z"
        },
        "statusFlag":{
            "type":"boolean",
            "example":true
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
                }
            ]
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
    }
]

Nested Schema : user

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            }
        }
    }
}

Nested Schema : userRole

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleLinkItem"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserLinkItem
  Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    }
}

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserRoleLinkItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRoleLinkItem"
    }
}

Nested Schema : UserRoleLinkItem

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/639"
    }
}

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/639"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

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.

Back to Top