The following table consists of the attributes that can be mapped on a user during provisioning. For more information, see the Egnyte User Management API.
|The Egnyte username for the user. This attribute is required.
The authentication type for the user. This attribute is required. Available options include:
An immutable unique identifier for the user. This can be any plain text value identifier. This attribute is required.
Warning: This field is immutable meaning once set, it can never be updated.
The last name of the user. This attribute is required.
The first name of the user. This attribute is required.
If set to true when creating a user, an invitation email will be sent if the user is created in active state in the LDAP data store. If the user is disabled in the LDAP data store when they are created, no email is sent. This attribute is required. Available options include:
The Egnyte username for the user. This attribute is required.
Note: Usernames must start with a letter or digit. Special characters are not supported (with the exception of periods, hyphens, and underscores).
Important: It is not possible to change a user’s userName after they are created.
|The type of the user. This attribute is required. Acceptable options include:
Only required if the user’s authType is set to 'sso'.
This is how the user is identified within the SAML response from an SSO identity provider. For example, the SAML subject 'bjensen' or 'firstname.lastname@example.org'.
Tip: The idpUserId of a user must match the Default user mapping configured in Egnyte. For more information, see Configure Egnyte for SSO.
The role assigned to the user. Available options include 'default' or other existing custom role names.
Note: This option is only available to users with a userType of 'power'.
Only required if the user’s authType is set to 'ad'.
This field is used to bind child authentication policies to a user when using Active Directory authentication in a multi-domain setup. For example, 'email@example.com'.