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

# gpudb::CreateRoleRequest

> gpudb::CreateRoleRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a11c8fcda3ebbb876681b3b9f20e23a3c">GPUdb::createRole</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__role_8h_source">gpudb/protocol/create\_role.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a746e1c958a38c9af1878a02d20854f90" id="r_a746e1c958a38c9af1878a02d20854f90">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a746e1c958a38c9af1878a02d20854f90">CreateRoleRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a746e1c958a38c9af1878a02d20854f90">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateRoleRequest" title="A set of parameters for GPUdb::createRole.">CreateRoleRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a746e1c958a38c9af1878a02d20854f90">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a517a7c44400d4c302b2c3416d8ee8bde" id="r_a517a7c44400d4c302b2c3416d8ee8bde">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a517a7c44400d4c302b2c3416d8ee8bde">CreateRoleRequest</a> (const std::string \&name\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a517a7c44400d4c302b2c3416d8ee8bde">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateRoleRequest" title="A set of parameters for GPUdb::createRole.">CreateRoleRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a517a7c44400d4c302b2c3416d8ee8bde">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a2f85c97f5c5fcc6944afd314c6c17a38" id="r_a2f85c97f5c5fcc6944afd314c6c17a38">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2f85c97f5c5fcc6944afd314c6c17a38">name</a></td>
      </tr>

      <tr className="memdesc:a2f85c97f5c5fcc6944afd314c6c17a38">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the role to be created. <br /></td>
      </tr>

      <tr className="separator:a2f85c97f5c5fcc6944afd314c6c17a38">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a6a400ba0f54777caec8f31c05f2f1c5b" id="r_a6a400ba0f54777caec8f31c05f2f1c5b">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6a400ba0f54777caec8f31c05f2f1c5b">options</a></td>
      </tr>

      <tr className="memdesc:a6a400ba0f54777caec8f31c05f2f1c5b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a6a400ba0f54777caec8f31c05f2f1c5b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a11c8fcda3ebbb876681b3b9f20e23a3c">GPUdb::createRole</a>. </p>
      <p>Creates a new role. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__role_8h_source#l00017">17</a> of file <a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a746e1c958a38c9af1878a02d20854f90">◆ </a></span>CreateRoleRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateRoleRequest::CreateRoleRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateRoleRequest" title="A set of parameters for GPUdb::createRole.">CreateRoleRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__role_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a517a7c44400d4c302b2c3416d8ee8bde">◆ </a></span>CreateRoleRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::CreateRoleRequest::CreateRoleRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateRoleRequest" title="A set of parameters for GPUdb::createRole.">CreateRoleRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">name\_</td>
                <td>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. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#abad782c584538b4c7792f3f92a9e834a">create\_role\_resource\_group</a>: Name of an existing resource group to associate with this user. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__role_8h_source#l00044">44</a> of file <a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a2f85c97f5c5fcc6944afd314c6c17a38">◆ </a></span>name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::CreateRoleRequest::name</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the role to be created. </p>
        <p>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. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__role_8h_source#l00055">55</a> of file <a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a6a400ba0f54777caec8f31c05f2f1c5b">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::CreateRoleRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#abad782c584538b4c7792f3f92a9e834a">create\_role\_resource\_group</a>: Name of an existing resource group to associate with this user. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__role_8h_source#l00066">66</a> of file <a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/create__role_8h_source">create\_role.h</a></li>
    </ul>
  </div>
</div>