CreateUserSamlObject

The object used to create a new user when SAML authentication is used.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

lastName

User's last name

Y

string

adminType

Set the user's administration level using the admin type enumeration

Y

AdminType

proxyAccount

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

-

string

clientLicenseType

The user's license type using the type enumeration

Y

ClientLicenseType

principalName

The user's SAML identifier

Y

string

language

The user's language

-

LanguageType

userName

The login username for the user

Y

string

firstName

User's first name

Y

string

password

User's password. relevant only for enterprise admin users

-

string

roleIds

The user's roles using role ID's

-

string [ ]

privateProfileId

The user's Profile Id

-

string

statusID

The user's status using the status type enumeration

-

UserStatus

profileType

Set the user's profileType

-

UserProfileType

phone

User's phone - needed for automation and messaging

-

string

tenantId

The user's tenancy if using multi-tenancy. If not, use the default tenancy of '90000000-0000-0000-0000-000000000009'

-

string

id

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

-

string

uuid

proxy2

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

-

string

email

User's email address - needed for automation and messaging

Y

string

*Required elements are only used for API parameters

Usages
  • /API2/access/createUserSaml
  • /API2/access/createUsersSaml