Create External User

Creates a new external user (a user whose credentials are managed by an external LDAP).

NOTE: This endpoint should be used for on-premise deployments only.

Input Parameter Description

Name Type Description
name string Name of the user to be created. Must exactly match the user's name in the external LDAP, prefixed with a @. Must not be the same name as an existing user.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description
create_home_directory

when true, a home directory in KiFS is created for this user The default value is true. The supported values are:

  • true
  • false

Output Parameter Description

Name Type Description
name string Value of input parameter name.
info map of string to strings Additional information.