Skip Navigation

Types of user accounts

The table below describes the types of user accounts that you can create. The sample application creates a directory user account. For more information about creating user accounts, see 
BWS.createUsers()
 in the API Reference.
The 
BWS.createUsers()
 API passes a 
CreateUsersRequest
 object in its request. The 
CreateUsersRequest
 object contains the metadata for the request, and 
NewUser
 objects that represent the user accounts that you want to create. 
NewUser
 contains the following properties:
  • AccountAttributes
    : The account attributes that distinguish the user, such as the user's email address.
  • DeviceActivationType
    : Not currently supported.
  • UserAttributes
    : Contains the authentication information for administrator accounts or local user accounts.
  • Server
    : Not currently supported. Should be set to null.
User type
Configuration of NewUser in CreateUsersRequest
Directory user
  • A standard user that does not require login information for the administration console.
  • An administrator can assign a device to the user, or the user can activate a device.
AccountAttributes
Specify any of the following fields:
  • A valid email address for 
    emailAddress
  • An identifier from your organization’s directory (
    Microsoft Active Directory
     or LDAP) for 
    externalUserUid
  • A valid distinguished name for 
    userDistinguishedName
DeviceActivationType
  • Not currently supported.
UserAttributes
  • Null
Server
  • Not currently supported.
Local user
  • A local user account that is not integrated with the directory.
  • An administrator can assign a device to the user, or the user can activate a device.
AccountAttributes
  • Set 
    localUser
     to true
  • Optional: A valid email address for 
    emailAddress
DeviceActivationType
  • Not currently supported.
UserAttributes
  • For 
    authenticator
    , set 
    authenticatorType
     to internal (local user accounts don't support directory authentication).
  • Specify 
    loginName
    loginPassword
    , and 
    displayName
    .
Server
  • Not currently supported.
Administrator account
  • An administrator user that is assigned login information and an administrative role.
  • An administrator can assign a device to the user.
AccountAttributes
Specify any of the following fields:
  • A valid email address for 
    emailAddress
  • An identifier from your organization’s directory (
    Microsoft Active Directory
     or LDAP) for 
    externalUserUid
  • A valid distinguished name for 
    userDistinguishedName
DeviceActivationType
  • Not currently supported.
UserAttributes
  • Specify 
    authenticator
     to select the type of authentication. You can retrieve a list of supported authenticators using the BWSUtil.getAuthenticators API.
  • For local user authentication, specify 
    loginName
    loginPassword
    , and 
    displayName
    .
  • For 
    Microsoft Active Directory
     authentication, specify 
    loginName
    domain
    , and 
    displayName
    .
  • For LDAP authentication, specify 
    loginName
     and 
    displayName
    .
  • Specify 
    roleUid
     to select the administrative role. You can retrieve a list of available roles using 
    BWS.getRoles()
    .
Server
  • Not currently supported.
Administrator account with permissions granted by group membership
  • A user with login information, but no administrative role.
  • Create this type of user only if you want to give the user administrative permissions by adding the user to a group with an administrative role.
AccountAttributes
  • Null
DeviceActivationType
  • Not currently supported.
UserAttributes
  • Specify 
    authenticator
     to select the type of authentication. You can retrieve a list of supported authenticators using 
    BWSUtil.getAuthenticators()
    .
  • For local user authentication, specify 
    loginName
    loginPassword
    , and 
    displayName
    .
  • For 
    Microsoft Active Directory
     authentication, specify 
    loginName
    domain
    , and 
    displayName
    .
  • For LDAP authentication, specify 
    loginName
     and 
    displayName
    .
  • Do not specify 
    roleUid
    .
Server
  • Not currently supported.