Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.63 KB

user_create.rst

File metadata and controls

65 lines (44 loc) · 1.63 KB
Raw

user_create

POST /users

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 1.0

Creates a new user on the platform.

As part of the creation the user will be assigned to an organization and be setup using a subscription profile. If not subscription profile is specified, the default subscription profile will be used. A creation code os also specified, allowing user creation to be tracked. Other access rights including being an administrator of the organization can be specified as part of the creation.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: None

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A user-object object

Example Request

curl "https://uforge.example.com/api/users" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:user xmlns:ns0="http://www.usharesoft.com/uforge">
    <loginName>example</loginName>
    <active>true</active>
    <email>example@example.com</email>
    <creationCode>default</creationCode>
    <password>example</password>
</ns0:user>
  • user-object
  • userAdminStatus-change
  • userOrg-getAll
  • userOrg-remove
  • user-get
  • user-getAll
  • user-update