> ## 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::GrantPermissionCredentialRequest

> gpudb::GrantPermissionCredentialRequest — 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#a5af24b8cecd2bbd61c1fb7e9725e33a8">GPUdb::grantPermissionCredential</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">gpudb/protocol/grant\_permission\_credential.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:a7718cf49292da705e7ee2450f65add4d" id="r_a7718cf49292da705e7ee2450f65add4d">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7718cf49292da705e7ee2450f65add4d">GrantPermissionCredentialRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a7718cf49292da705e7ee2450f65add4d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GrantPermissionCredentialRequest" title="A set of parameters for GPUdb::grantPermissionCredential.">GrantPermissionCredentialRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a0f6f63243756d1d0b5eee730bbbc2788">
        <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:a9fac306c569de49f85507becbe1ec0b9" id="r_a9fac306c569de49f85507becbe1ec0b9">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9fac306c569de49f85507becbe1ec0b9">name</a></td>
      </tr>

      <tr className="memdesc:a9fac306c569de49f85507becbe1ec0b9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the user or role to which the permission will be granted. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ac0d0d8bf8e2383f8762bde9b24cacd05">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Permission to grant to the user or role. <br /></td>
      </tr>

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

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

      <tr className="memdesc:adc033679478027965135d9238a4e0894">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the credential on which the permission will be granted. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a1022a68bf1aea0022ddfea74bb6c8a01">
        <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#a5af24b8cecd2bbd61c1fb7e9725e33a8">GPUdb::grantPermissionCredential</a>. </p>
      <p>Grants a <a href="/content/security/sec_concepts/#security-concepts-permissions-credential" target="_top">credential-level permission</a> to a user or role. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7718cf49292da705e7ee2450f65add4d">◆ </a></span>GrantPermissionCredentialRequest() <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::GrantPermissionCredentialRequest::GrantPermissionCredentialRequest </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_1GrantPermissionCredentialRequest" title="A set of parameters for GPUdb::grantPermissionCredential.">GrantPermissionCredentialRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0f6f63243756d1d0b5eee730bbbc2788">◆ </a></span>GrantPermissionCredentialRequest() <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::GrantPermissionCredentialRequest::GrantPermissionCredentialRequest </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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">permission\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">credentialName\_</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_1GrantPermissionCredentialRequest" title="A set of parameters for GPUdb::grantPermissionCredential.">GrantPermissionCredentialRequest</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 user or role to which the permission will be granted. Must be an existing user or role. </td>
              </tr>

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

                <td>
                  Permission to grant to the user or role. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3415c25f8cafd174adfbe1df56c54db0">grant\_permission\_credential\_credential\_admin</a>: Full read/write and administrative access on the credential. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3b091a1057fa2c25e943bbe3dc6d9034">grant\_permission\_credential\_credential\_read</a>: Ability to read and use the credential. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">credentialName\_</td>
                <td>Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. 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/grant__permission__credential_8h_source#l00061">61</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the credential on which the permission will be granted. </p>
        <p>Must be an existing credential, or an empty string to grant access on all credentials. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00094">94</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9fac306c569de49f85507becbe1ec0b9">◆ </a></span>name</h2>

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

      <div className="memdoc">
        <p>Name of the user or role to which the permission will be granted. </p>
        <p>Must be an existing user or role. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00073">73</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00099">99</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac0d0d8bf8e2383f8762bde9b24cacd05">◆ </a></span>permission</h2>

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

      <div className="memdoc">
        <p>Permission to grant to the user or role. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3415c25f8cafd174adfbe1df56c54db0">grant\_permission\_credential\_credential\_admin</a>: Full read/write and administrative access on the credential. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3b091a1057fa2c25e943bbe3dc6d9034">grant\_permission\_credential\_credential\_read</a>: Ability to read and use the credential. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source#l00087">87</a> of file <a className="el" href="/content/api/cpp/grant__permission__credential_8h_source">grant\_permission\_credential.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/grant__permission__credential_8h_source">grant\_permission\_credential.h</a></li>
    </ul>
  </div>
</div>