/create/user/internal

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/create/user/internal

Creates a new internal user (a user whose credentials are managed by the database system).

Input Parameter Description

NameTypeDescription
namestringName of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
passwordstringInitial password of the user to be created. May be an empty string for no password.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
resource_groupName of an existing resource group to associate with this user
default_schemadefault schema associate with this user

Output Parameter Description

The GPUdb 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'create_user_internal_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /create/user/internal endpoint:

NameTypeDescription
namestringValue of input parameter name.
infomap of string to stringsAdditional information. The default value is an empty map ( {} ).Possible keys are:

Empty string in case of an error.