user_mgr_add

Back to SOAP Architecture Method Reference

Description

The user_mgr_add method adds a new user to your domain.

Parameters

Parameter Element Subparameter Description Type Required (R) or Optional (O)
sequence container_scope can_see_above Indicates whether or not folder scoping is active on this resource. Boolean R
scope_container_group_id Indicates the resource folder type for scoping:
  • 0 = Content
  • 2 = Host (Player)
  • 3 = Reservation/Campaign
  • 4 = Criteria
  • 5 = Category
  • 6 = Location (Edge Server)
  • 8 = Display Unit
  • 15 = Configuration Profile
  • 16 = Media Package
  • 17 = Order
  • 19 = Event
  • 20 = Loop Policy
  • 22 = Group
  • 23 = User
  • 24 = Customer
  • 26 = Display Type
 bstypes:ContainerGroup R
scope_container_id Description bstypes:ResourceId R
group id The unique ID# of the group. bstypes:ResourceId R
domain_id N/A N/A The unique ID# of your domain. bstypes:ResourceId R
name N/A N/A The name of the user resource (can be the user's given name, a title, etc.). string R
passwd N/A N/A The log-on password for the user. The password must have the following:
    • a minimum of 8 characters
    • a minimum of 1 non-alphabetic characters
 string R
username N/A N/A The log-on username for the user. string R
container_id N/A N/A The unique ID# of the user's folder, if applicable. bstypes:ResourceId O

Return Values

Value Description Type Required (R) or Optional (O)
id The unique ID# of the new user resource. bstypes:ResourceId R