Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
GITBOOK-1218: Update role endpoint - fix error
Browse files Browse the repository at this point in the history
  • Loading branch information
rachana-visavadiya authored and gitbook-bot committed Dec 28, 2023
1 parent 0891cd0 commit d8ed6f7
Showing 1 changed file with 1 addition and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@

<table><thead><tr><th width="163">HTTP Method</th><th width="319">URL</th><th>Requires Auth</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>/api/v1/roles.update</code></td><td><a href="../../authentication-endpoints/"><code>yes</code></a></td></tr></tbody></table>

{% hint style="info" %}
Permission required: `access-permissions`
{% endhint %}

## Body Parameters

<table><thead><tr><th width="201.33333333333331">Key</th><th width="230">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>roleId</code><mark style="color:red;"><code>*</code></mark></td><td><code>646c431fa8c3a3ba32d0e1c4</code></td><td>The role ID that you want to update.</td></tr><tr><td><code>name</code><mark style="color:red;"><code>*</code></mark></td><td><code>newRole</code></td><td>The updated name of the role.</td></tr><tr><td><code>scope</code></td><td><code>Subscriptions</code></td><td>The updated scope of the role. The default value is <code>Users</code>.</td></tr><tr><td><code>description</code></td><td><code>Role description</code></td><td>A updated description for the role.</td></tr><tr><td><code>mandatory2fa</code></td><td><code>true</code></td><td>Whether the role should have a mandatory 2FA. The default role is <code>false</code>.</td></tr></tbody></table>
<table><thead><tr><th width="201.33333333333331">Key</th><th width="230">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>roleId</code><mark style="color:red;"><code>*</code></mark></td><td><code>646c431fa8c3a3ba32d0e1c4</code></td><td>The role ID that you want to update.</td></tr><tr><td><code>name</code><mark style="color:red;"><code>*</code></mark></td><td><code>newRole</code></td><td>The updated name of the role.</td></tr><tr><td><code>scope</code></td><td><code>Subscriptions</code></td><td>The updated scope of the role. The default value is <code>Users</code>.</td></tr><tr><td><code>description</code></td><td><code>Role description</code></td><td>Updated description for the role.</td></tr><tr><td><code>mandatory2fa</code></td><td><code>true</code></td><td>Whether the role should have a mandatory 2FA. The default value is <code>false</code>.</td></tr></tbody></table>

## Example Call

Expand Down

0 comments on commit d8ed6f7

Please sign in to comment.