jsdocs/Role.html

<!DOCTYPE html>
<html lang="en">
<head>
    
    <meta charset="utf-8">
    <title>Role - Documentation</title>
    
    
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
    <link rel="canonical" href="https://www.contentstack.com/docs/developers/javascript-management/api-reference/">
    <script src="scripts/nav.js" defer></script>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- Google Tag Manager -->
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
        new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
        j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
        'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
        })(window,document,'script','dataLayer','GTM-WGP99J7');</script>
    <!-- End Google Tag Manager -->
</head>
<body>
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WGP99J7" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav >
    
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="Contentstack.html">Contentstack</a><ul class='members'><li data-type='member'><a href="Contentstack.html#.client">client</a></li></ul></li><li><a href="ContentstackClient.html">ContentstackClient</a><ul class='methods'><li data-type='method'><a href="ContentstackClient.html#.login">login</a></li><li data-type='method'><a href="ContentstackClient.html#.getUser">getUser</a></li><li data-type='method'><a href="ContentstackClient.html#.stack">stack</a></li><li data-type='method'><a href="ContentstackClient.html#.organization">organization</a></li><li data-type='method'><a href="ContentstackClient.html#.logout">logout</a></li></ul></li><li><a href="User.html">User</a><ul class='methods'><li data-type='method'><a href="User.html#.update">update</a></li><li data-type='method'><a href="User.html#.delete">delete</a></li><li data-type='method'><a href="User.html#.requestPassword">requestPassword</a></li><li data-type='method'><a href="User.html#.resetPassword">resetPassword</a></li></ul></li><li><a href="Organization.html">Organization</a><ul class='methods'><li data-type='method'><a href="Organization.html#.fetch">fetch</a></li><li data-type='method'><a href="Organization.html#.stacks">stacks</a></li><li data-type='method'><a href="Organization.html#.transferOwnership">transferOwnership</a></li><li data-type='method'><a href="Organization.html#.addUser">addUser</a></li><li data-type='method'><a href="Organization.html#.getInvitations">getInvitations</a></li><li data-type='method'><a href="Organization.html#.resendInvitition">resendInvitition</a></li><li data-type='method'><a href="Organization.html#.roles">roles</a></li><li data-type='method'><a href="Organization.html#.fetchAll">fetchAll</a></li></ul></li><li><a href="Stack.html">Stack</a><ul class='methods'><li data-type='method'><a href="Stack.html#.update">update</a></li><li data-type='method'><a href="Stack.html#.fetch">fetch</a></li><li data-type='method'><a href="Stack.html#contentType">contentType</a></li><li data-type='method'><a href="Stack.html#locale">locale</a></li><li data-type='method'><a href="Stack.html#asset">asset</a></li><li data-type='method'><a href="Stack.html#globalField">globalField</a></li><li data-type='method'><a href="Stack.html#environment">environment</a></li><li data-type='method'><a href="Stack.html#deliveryToken">deliveryToken</a></li><li data-type='method'><a href="Stack.html#extension">extension</a></li><li data-type='method'><a href="Stack.html#webhook">webhook</a></li><li data-type='method'><a href="Stack.html#label">label</a></li><li data-type='method'><a href="Stack.html#release">release</a></li><li data-type='method'><a href="Stack.html#bulkOperation">bulkOperation</a></li><li data-type='method'><a href="Stack.html#.users">users</a></li><li data-type='method'><a href="Stack.html#.transferOwnership">transferOwnership</a></li><li data-type='method'><a href="Stack.html#.settings">settings</a></li><li data-type='method'><a href="Stack.html#.resetSettings">resetSettings</a></li><li data-type='method'><a href="Stack.html#.addSettings">addSettings</a></li><li data-type='method'><a href="Stack.html#.share">share</a></li><li data-type='method'><a href="Stack.html#.unShare">unShare</a></li><li data-type='method'><a href="Stack.html#.role">role</a></li><li data-type='method'><a href="Stack.html#.create">create</a></li><li data-type='method'><a href="Stack.html#.query">query</a></li></ul></li><li><a href="ContentType.html">ContentType</a><ul class='methods'><li data-type='method'><a href="ContentType.html#.update">update</a></li><li data-type='method'><a href="ContentType.html#.delete">delete</a></li><li data-type='method'><a href="ContentType.html#.fetch">fetch</a></li><li data-type='method'><a href="ContentType.html#entry">entry</a></li><li data-type='method'><a href="ContentType.html#.generateUid">generateUid</a></li><li data-type='method'><a href="ContentType.html#.create">create</a></li><li data-type='method'><a href="ContentType.html#.query">query</a></li><li data-type='method'><a href="ContentType.html#.import">import</a></li></ul></li><li><a href="GlobalField.html">GlobalField</a><ul class='methods'><li data-type='method'><a href="GlobalField.html#.update">update</a></li><li data-type='method'><a href="GlobalField.html#.delete">delete</a></li><li data-type='method'><a href="GlobalField.html#.fetch">fetch</a></li><li data-type='method'><a href="GlobalField.html#.create">create</a></li><li data-type='method'><a href="GlobalField.html#.query">query</a></li><li data-type='method'><a href="GlobalField.html#.import">import</a></li></ul></li><li><a href="Entry.html">Entry</a><ul class='methods'><li data-type='method'><a href="Entry.html#.update">update</a></li><li data-type='method'><a href="Entry.html#.delete">delete</a></li><li data-type='method'><a href="Entry.html#.fetch">fetch</a></li><li data-type='method'><a href="Entry.html#.publish">publish</a></li><li data-type='method'><a href="Entry.html#.unpublish">unpublish</a></li><li data-type='method'><a href="Entry.html#.create">create</a></li><li data-type='method'><a href="Entry.html#.query">query</a></li><li data-type='method'><a href="Entry.html#.import">import</a></li></ul></li><li><a href="Asset.html">Asset</a><ul class='methods'><li data-type='method'><a href="Asset.html#.update">update</a></li><li data-type='method'><a href="Asset.html#.delete">delete</a></li><li data-type='method'><a href="Asset.html#.fetch">fetch</a></li><li data-type='method'><a href="Asset.html#.replace">replace</a></li><li data-type='method'><a href="Asset.html#.publish">publish</a></li><li data-type='method'><a href="Asset.html#.unpublish">unpublish</a></li><li data-type='method'><a href="Asset.html#.folder">folder</a></li><li data-type='method'><a href="Asset.html#.create">create</a></li><li data-type='method'><a href="Asset.html#.query">query</a></li></ul></li><li><a href="Folder.html">Folder</a><ul class='methods'><li data-type='method'><a href="Folder.html#.update">update</a></li><li data-type='method'><a href="Folder.html#.delete">delete</a></li><li data-type='method'><a href="Folder.html#.fetch">fetch</a></li><li data-type='method'><a href="Folder.html#.create">create</a></li></ul></li><li><a href="BulkOperation.html">BulkOperation</a><ul class='methods'><li data-type='method'><a href="BulkOperation.html#.publish">publish</a></li><li data-type='method'><a href="BulkOperation.html#.unpublish">unpublish</a></li><li data-type='method'><a href="BulkOperation.html#.delete">delete</a></li></ul></li><li><a href="Extension.html">Extension</a><ul class='methods'><li data-type='method'><a href="Extension.html#.update">update</a></li><li data-type='method'><a href="Extension.html#.delete">delete</a></li><li data-type='method'><a href="Extension.html#.fetch">fetch</a></li><li data-type='method'><a href="Extension.html#.upload">upload</a></li><li data-type='method'><a href="Extension.html#.create">create</a></li><li data-type='method'><a href="Extension.html#.query">query</a></li></ul></li><li><a href="Release.html">Release</a><ul class='methods'><li data-type='method'><a href="Release.html#.update">update</a></li><li data-type='method'><a href="Release.html#.fetch">fetch</a></li><li data-type='method'><a href="Release.html#.delete">delete</a></li><li data-type='method'><a href="Release.html#.item">item</a></li><li data-type='method'><a href="Release.html#.deploy">deploy</a></li><li data-type='method'><a href="Release.html#.clone">clone</a></li><li data-type='method'><a href="Release.html#.create">create</a></li><li data-type='method'><a href="Release.html#.query">query</a></li></ul></li><li><a href="Label.html">Label</a><ul class='methods'><li data-type='method'><a href="Label.html#.update">update</a></li><li data-type='method'><a href="Label.html#.delete">delete</a></li><li data-type='method'><a href="Label.html#.fetch">fetch</a></li><li data-type='method'><a href="Label.html#.create">create</a></li><li data-type='method'><a href="Label.html#.query">query</a></li></ul></li><li><a href="Locale.html">Locale</a><ul class='methods'><li data-type='method'><a href="Locale.html#.update">update</a></li><li data-type='method'><a href="Locale.html#.delete">delete</a></li><li data-type='method'><a href="Locale.html#.fetch">fetch</a></li><li data-type='method'><a href="Locale.html#.create">create</a></li><li data-type='method'><a href="Locale.html#.query">query</a></li></ul></li><li><a href="Role.html">Role</a><ul class='methods'><li data-type='method'><a href="Role.html#.update">update</a></li><li data-type='method'><a href="Role.html#.delete">delete</a></li><li data-type='method'><a href="Role.html#.fetch">fetch</a></li><li data-type='method'><a href="Role.html#.create">create</a></li><li data-type='method'><a href="Role.html#.findAll">findAll</a></li><li data-type='method'><a href="Role.html#.query">query</a></li></ul></li><li><a href="Webhook.html">Webhook</a><ul class='methods'><li data-type='method'><a href="Webhook.html#.update">update</a></li><li data-type='method'><a href="Webhook.html#.delete">delete</a></li><li data-type='method'><a href="Webhook.html#.fetch">fetch</a></li><li data-type='method'><a href="Webhook.html#.executions">executions</a></li><li data-type='method'><a href="Webhook.html#retry">retry</a></li><li data-type='method'><a href="Webhook.html#.create">create</a></li><li data-type='method'><a href="Webhook.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="Webhook.html#.import">import</a></li></ul></li></ul>
</nav>

<div id="main">
    
    <h1 class="page-title">Role</h1>
    

<section>

<header>
    
        <h2>
        Role
        </h2>
        
    
</header>

<article>
    
        <div class="container-overview">
        
            
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line5">line 5</a>
    </li></ul></dd>
    

</dl>


                <div class="description usertext">A role is a collection of permissions that will be applicable to all the users who are assigned this role. Read more about <a href= 'https://www.contentstack.com/docs/guide/users-and-roles#roles'>Roles</a>.</div>
            

        </div>
    

        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id=".update"><span class="type-signature">(static) </span>update<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Role.Role>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line16">line 16</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The Update role call lets you modify an existing role of your stack.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()

client.stack({ api_key: 'api_key'}).role('role_uid').fetch({ include_rules: true, include_permissions: true})
.then((role) => {
 role.name = 'My New Role'
 role.description = 'Role description'
 role.rules = [
{
  module: 'asset',
  assets: ['$all'],
  acl: {
    read: true,
    create: true,
    update: true,
    publish: true,
    delete: true
  }
},
{
  module: 'environment',
  environments: [],
  acl: { read: true }
},
{
  module: 'locale',
  locales: [Array],
  acl: { read: true }
}]
 return role.update()
})
.then((role) => console.log(role))</code></pre>


<h5>Returns:</h5>

        
<div class="param-desc">
    Promise for Role instance
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Role.Role></span>


    </dd>
</dl>

    
    <h4 class="name" id=".delete"><span class="type-signature">(static) </span>delete<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line58">line 58</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The Delete role call deletes an existing role from your stack.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()

client.stack({ api_key: 'api_key'}).role('role_uid').delete()
.then((response) => console.log(response.notice))</code></pre>


<h5>Returns:</h5>

        
<div class="param-desc">
    Response Object.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
    <h4 class="name" id=".fetch"><span class="type-signature">(static) </span>fetch<span class="signature">(include_permissions, include_rules)</span><span class="type-signature"> &rarr; {Promise.&lt;Role.Role>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line72">line 72</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The Get a single role request returns comprehensive information on a specific role.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()

client.stack({ api_key: 'api_key'}).role('role_uid').fetch()
.then((role) => console.log(role))</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>include_permissions</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this parameter to 'true' to include the details of the permissions assigned to a particular role.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>include_rules</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this to ‘true’ to include the details of the rules assigned to a role.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    Promise for Role instance
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Role.Role></span>


    </dd>
</dl>

    
    <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Role.Role>}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line90">line 90</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The Create a role call creates a new role in a stack.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()
const role =  {
  name: 'Role Name',
  description: 'From CMA Js',
  rules:
    [
      {
        module: 'environment',
        environments: [],
        acl: { read: true }
      },
      {
        module: 'locale',
        locales: [],
        acl: { read: true }
      }
    ],
  uid: 'uid'
}
client.stack().role().create({ role })
.then((role) => console.log(role))</code></pre>


<h5>Returns:</h5>

        
<div class="param-desc">
    Promise for Role instance
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Promise.&lt;Role.Role></span>


    </dd>
</dl>

    
    <h4 class="name" id=".findAll"><span class="type-signature">(static) </span>findAll<span class="signature">(include_permissions, include_rules)</span><span class="type-signature"> &rarr; {ContentstackCollection}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line122">line 122</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The ‘Get all roles’ request returns comprehensive information about all roles created in a stack.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()

client.stack().role().findAll()
.then((collection) => console.log(collection))</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>include_permissions</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this parameter to 'true' to include the details of the permissions assigned to a particular role.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>include_rules</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this to ‘true’ to include the details of the rules assigned to a role.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    Instance of ContentstackCollection.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ContentstackCollection</span>


    </dd>
</dl>

    
    <h4 class="name" id=".query"><span class="type-signature">(static) </span>query<span class="signature">(include_permissions, include_rules)</span><span class="type-signature"> &rarr; {ContentstackCollection}</span></h4>

    
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="stack_roles_index.js.html">stack/roles/index.js</a>, <a href="stack_roles_index.js.html#line158">line 158</a>
    </li></ul></dd>
    

</dl>


<div class="description usertext">
    The Query on Role will allow to fetch details of all or specific role.
</div>


    <h5>Example</h5>
    
    <pre class="prettyprint"><code>import * as contentstack from '@contentstack/management'
const client = contentstack.client()

client.stack({ api_key: 'api_key'}).role().query({ query: { filename: 'Asset Name' } }).find()
.then((role) => console.log(role))</code></pre>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>include_permissions</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this parameter to 'true' to include the details of the permissions assigned to a particular role.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>include_rules</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">Set this to ‘true’ to include the details of the rules assigned to a role.</td>
        </tr>

    
    </tbody>
</table>


<h5>Returns:</h5>

        
<div class="param-desc">
    Instance of ContentstackCollection.
</div>


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">ContentstackCollection</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> on Thu Dec 03 2020 11:19:18 GMT+0530 (India Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/polyfill.js"></script>
<script src="scripts/linenumber.js"></script>


</body>
</html>