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

# alterRole

<div className="kinetica-doxygen">
  <div id="ad2de7faffe3e2d362a46daaa71728deb" />

  <h2 className="memtitle"><span className="permalink"><a href="#ad2de7faffe3e2d362a46daaa71728deb">◆ </a></span>alterRole() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleResponse">AlterRoleResponse</a> kinetica.Kinetica.alterRole </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleRequest">AlterRoleRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Alters a Role. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L11211">11211</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="ab50e1e6651bf3aeee03ebf87a12315a7" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab50e1e6651bf3aeee03ebf87a12315a7">◆ </a></span>alterRole() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleResponse">AlterRoleResponse</a> kinetica.Kinetica.alterRole </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Alters a Role. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">name</td>
              <td>Name of the role to be altered. Must be an existing role.</td>
            </tr>

            <tr>
              <td className="paramname">action</td>

              <td>
                Modification operation to be applied to the role. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterRoleRequest_1_1Action#a0481a35aa551e325549a29ab2ba1cda0">SET\_COMMENT</a>: Sets the comment for an internal role. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterRoleRequest_1_1Action#ad5d4be517bf2597e4fe5aba3a9bba05c">SET\_RESOURCE\_GROUP</a>: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group. </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty Dictionary.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L11263">11263</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="aa74224416e4723ee49f531bd8a157255" />

  <h2 className="memtitle"><span className="permalink"><a href="#aa74224416e4723ee49f531bd8a157255">◆ </a></span>AlterRoleAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleResponse">AlterRoleResponse</a> > kinetica.Kinetica.AlterRoleAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleRequest">AlterRoleRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Alters a Role. </p>
      <p>(async)</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L11226">11226</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a0697fb129381e2d4a20a9332d368daee" />

  <h2 className="memtitle"><span className="permalink"><a href="#a0697fb129381e2d4a20a9332d368daee">◆ </a></span>AlterRoleAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AlterRoleResponse">AlterRoleResponse</a> > kinetica.Kinetica.AlterRoleAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Alters a Role. </p>
      <p>(async)</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">name</td>
              <td>Name of the role to be altered. Must be an existing role.</td>
            </tr>

            <tr>
              <td className="paramname">action</td>

              <td>
                Modification operation to be applied to the role. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterRoleRequest_1_1Action#a0481a35aa551e325549a29ab2ba1cda0">SET\_COMMENT</a>: Sets the comment for an internal role. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterRoleRequest_1_1Action#ad5d4be517bf2597e4fe5aba3a9bba05c">SET\_RESOURCE\_GROUP</a>: Sets the resource group for an internal role. The resource group must exist, otherwise, an empty string assigns the role to the default resource group. </li>
                </ul>
              </td>
            </tr>

            <tr>
              <td className="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> .</td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. The default value is an empty Dictionary.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L11302">11302</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>