> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /create/user/external

```
URL: http://<db.host>:<db.port>/create/user/external
```

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

<ParamField body="name" type="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.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

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

  <Expandable title="options">
    <ParamField body="activated">
      Is the user allowed to login.

      The default value is `true`.

      * **true**: User may login.
      * **false**: User may not login.
    </ParamField>

    <ParamField body="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
    </ParamField>

    <ParamField body="default_schema">
      Default schema to associate with this user.
    </ParamField>

    <ParamField body="directory_data_limit">
      The maximum capacity to apply to the created directory if *create\_home\_directory* is *true*. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
    </ParamField>

    <ParamField body="resource_group">
      Name of an existing resource group to associate with this user.
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'create\_user\_external\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /create/user/external endpoint:

  <Expandable title="data_str">
    <ResponseField name="name" type="string">
      Value of input parameter *name*.
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>