> ## 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_role

### create\_role

<ul>
  <li>
    create\_role(\
    &#x20;name: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[CreateRoleResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleResponse.md)>

    Creates a new role.**Note:** This method should be used for on-premise deployments only.

    #### Parameters

    <ul>
      <li>
        name: string

        Name of the role 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.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateRoleResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleResponse.md)>

    Promise\<Types.CreateRoleResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:6699](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L6699)</li>
    </ul>
  </li>
</ul>

### create\_role\_request

<ul>
  <li>
    create\_role\_request(\
    &#x20;request: [CreateRoleRequest](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md),\
    ): Promise\<[CreateRoleResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleResponse.md)>

    Creates a new role.**Note:** This method should be used for on-premise deployments only.

    #### Parameters

    <ul>
      <li>
        request: [CreateRoleRequest](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/typescript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[CreateRoleResponse](https://docs.kinetica.com/content/api/typescript/interfaces/CreateRoleResponse.md)>

    Promise\<Types.CreateRoleResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:6674](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L6674)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.