CreateUserFromSearchObject

The object used to create a new user from search.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

id

The user ID. If provided, the GUID will be used. Otherwise, the function will auto-create it.

 -

string

uuid

userName

The login username for the user. Specify when using LDAP authentication

 -

string

adminType

The user's administration level using the admin type enumeration

Y

AdminType

roleIds

The user's list of roles

 -

string [ ]

clientLicenseType

The user's license type using the type enumeration

Y

ClientLicenseType

statusID

The user's status using the status type enumeration

 -

UserStatus

tenantId

The user's tenant ID

 -

string

domainName

The domain name. Required in LDAP based authentications

 -

string

profileId

The profile ID to be applied for this user

 -

string

proxy2

The user's second proxy account needed for connecting to different data sources

 -

string

profileType

The user's profileType

 -

UserProfileType

language

The user's language

 -

LanguageType

searchValue

The search phrase to find the user in the IDP. Can vary between different providers. Specify in SAML/OpenID.

 -

string

*Required elements are only used for API parameters

Notes

The search is done by 'domainName\userName' in LDAP, or by 'searchValue' in OpenID/SAML

Usages
  • /API3/access/createUsersFromSearch