Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 2.2 KB

installProfileUser_create.rst

File metadata and controls

80 lines (58 loc) · 2.2 KB
Raw

installProfileUser_create

POST /users/{uid}/appliances/{aid}/installProfile/{ipid}/users

Summary

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

Adds a new OS user in an install profile.

Refer to osuser-object for the mandatory and optional attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: appliance_create

URI Parameters

  • uid (required): the user name (login name) of the user-object that has created the appliance
  • ipid (required): the id of the installprofile-object
  • aid (required): the id of the appliance-object

HTTP Request Body Parameters

A osUser-object object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/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:osUser xmlns:ns0="http://www.usharesoft.com/uforge">
    <fullName>OSUserExample</fullName>
    <homeDir>/home/OSUserExample</homeDir>
    <name>OSUserExample</name>
    <password>password</password>
    <primaryGroupAuto>true</primaryGroupAuto>
    <shell>/bin/bash</shell>
    <systemUser>true</systemUser>
    <userIdAuto>true</userIdAuto>
</ns0:osUser>
  • appliance-object
  • applianceinstallprofile-api-resources
  • installProfileGroup-create
  • installProfileGroup-delete
  • installProfileGroup-deleteAll
  • installProfileGroup-get
  • installProfileGroup-getAll
  • installProfileGroup-update
  • installProfileUser-delete
  • installProfileUser-deleteAll
  • installProfileUser-get
  • installProfileUser-getAll
  • installProfileUser-update
  • installprofile-object
  • osgroup-object
  • osuser-object