Red Hat Network API: user

Description

User namespace contains methods to access common user functions available from the web user interface.

Namespace: user

Method: addRole

Parameters:

• string sessionKey
• string login - user to update.
• string role - name of role to grant

Returns:

• int

Method: createUser

Invoker must be an Org-Admin in their Org.

detail-keys include the following:

• address1
• address2
• city
• country
• email
• login
• prefix
• password
• phone
• state
• county
• zip

State is required for Argentina, Australia, Brazil, Canada, China, India, Malaysia, and USA. Address2 is required for Brazil. County is auto-populated for US users based on zip code if no value provided; all other details are REQUIRED

Users are created with NO ASSIGNED ROLES

Errors are reflected back to the caller as an xmlrpclib.Fault.faultCode of -500, .faultString containing a list of the errors encountered.

Parameters:

• string sessionKey
• struct (user's details)
  • string "address1"
  • string "address2" (optional)
  • string "city"
  • string "country" (two-character country code)
  • string "email"
  • string "first_names"
  • string "last_name"
  • string "login"
  • string "password"
  • string "phone"
  • string "prefix" (one of Dr. , Hr. , Miss , Mr. , Mrs. , Ms. , Sr. )
  • string "state" (optional for non US/CA addresses)
  • string "county" (optional for non-US addresses; auto-populated based on zip code for US users if not provided)
  • string "zip"

Returns:

• int

Method: disable

Parameters:

• string sessionKey
• string login - login to disable.

Returns:

• int

Method: enable

Parameters:

• string sessionKey
• string login - login to enable.

Returns:

• int

Method: getDetails

Parameters:

• string sessionKey
• string login - user sought

Returns:

• struct (user details)
  • string "first_names"
  • string "last_name"
  • string "email"
  • string "prefix"
  • string "created_date"
  • string "disabled" - 'true'/'false', is this user disabled?

Method: listRoles

Parameters:

• string sessionKey
• string login - user sought

Returns:

• array
  • string (role label)

Method: listUsers

Parameters:

• string sessionKey

Returns:

• array
  • struct (user)
  • int "id"
  • string "login" - user's login name
  • string "login_uc" - uppercase version of login

Method: removeRole

Parameters:

• string sessionKey
• string login - user to update.
• string role - name of role to remove

Returns:

• int

Method: setDetails

Parameters:

• string sessionKey
• string login - user to update.
• struct (user's details)
  • string "first_names"
  • string "last_name"
  • string "email"
  • string "prefix"
  • string "password"

Returns:

• int