����JFIF��x�x����'
Server IP : 78.140.185.180 / Your IP : 216.73.216.45 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/www/vendor/rackspace/php-opencloud/doc/_build/html/services/identity/ |
Upload File : |
<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Roles — php-opencloud 1.12.1 documentation</title> <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> <link rel="top" title="php-opencloud 1.12.1 documentation" href="../../index.html"/> <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search"> <a href="../../index.html" class="fa fa-home"> php-opencloud</a> <div role="search"> <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul> <li class="toctree-l1"><a class="reference internal" href="../autoscale/index.html">Auto Scale v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../compute/index.html">Compute v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#glossary">Glossary</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Databases v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#glossary">Glossary</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../dns/index.html">DNS v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#glossary">Glossary</a></li> </ul> </li> </ul> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../../index.html">php-opencloud</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="../../index.html">Docs</a> »</li> <li>Roles</li> <li class="wy-breadcrumbs-aside"> <a href="../../_sources/services/identity/Roles.md.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main"> <div class="section" id="roles"> <h1>Roles<a class="headerlink" href="#roles" title="Permalink to this headline">¶</a></h1> <div class="section" id="intro"> <h2>Intro<a class="headerlink" href="#intro" title="Permalink to this headline">¶</a></h2> <p>A role is a personality that a user assumes when performing a specific set of operations. A role includes a set of rights and privileges. A user assuming a role inherits the rights and privileges associated with the role. A token that is issued to a user includes the list of roles the user can assume. When a user calls a service, that service determines how to interpret a user’s roles. A role that grants access to a list of operations or resources within one service may grant access to a completely different list when interpreted by a different service.</p> </div> <div class="section" id="setup"> <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> <p>Role objects are instantiated from the Identity service. For more details, see the <a class="reference external" href="Service.md">Service</a> docs.</p> </div> <div class="section" id="useful-object-properties-methods"> <h2>Useful object properties/methods<a class="headerlink" href="#useful-object-properties-methods" title="Permalink to this headline">¶</a></h2> <table border="1" class="docutils"> <colgroup> <col width="24%" /> <col width="38%" /> <col width="38%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Property</th> <th class="head">Getter</th> <th class="head">Setter</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>id</td> <td><tt class="docutils literal"><span class="pre">getId()</span></tt></td> <td><tt class="docutils literal"><span class="pre">setId()</span></tt></td> </tr> <tr class="row-odd"><td>name</td> <td><tt class="docutils literal"><span class="pre">getName()</span></tt></td> <td><tt class="docutils literal"><span class="pre">setName()</span></tt></td> </tr> <tr class="row-even"><td>description</td> <td><tt class="docutils literal"><span class="pre">getDescription()</span></tt></td> <td><tt class="docutils literal"><span class="pre">setDescription()</span></tt></td> </tr> </tbody> </table> </div> <div class="section" id="list-roles"> <h2>List roles<a class="headerlink" href="#list-roles" title="Permalink to this headline">¶</a></h2> <p>This call lists the global roles available within a specified service.</p> <div class="code php highlight-python"><div class="highlight"><pre>$roles = $service->getRoles(); foreach ($roles as $role) { // ... } </pre></div> </div> <p>For more information about how to use iterators, see the <a class="reference external" href="../Iterators.md">documentation</a>.</p> </div> <div class="section" id="get-role"> <h2>Get role<a class="headerlink" href="#get-role" title="Permalink to this headline">¶</a></h2> <p>This call lists detailed information (id, name, description) for a specified role.</p> <div class="code php highlight-python"><div class="highlight"><pre>$roleId = '123abc'; $role = $service->getRole($roleId); </pre></div> </div> </div> <div class="section" id="add-delete-user-roles"> <h2>Add/delete user roles<a class="headerlink" href="#add-delete-user-roles" title="Permalink to this headline">¶</a></h2> <p>To add/remove user roles, you must first instantiate a <a class="reference external" href="Users.md">user</a> object:</p> <div class="code php highlight-python"><div class="highlight"><pre>$roleId = '123abc'; // add role to user $user->addRole($roleId); // remove role from user $user->removeRole($roleId); </pre></div> </div> </div> <div class="section" id="list-user-global-roles"> <h2>List user global roles<a class="headerlink" href="#list-user-global-roles" title="Permalink to this headline">¶</a></h2> <p>This call returns a list of global roles associated with a user:</p> <div class="code php highlight-python"><div class="highlight"><pre>$roles = $user->getRoles(); foreach ($roles as $role) { // ... } </pre></div> </div> <p>For more information about how to use iterators, see the <a class="reference external" href="../Iterators.md">documentation</a>.</p> </div> </div> </div> <footer> <hr/> <div role="contentinfo"> <p> © Copyright 2015, Jamie Hannaford, Shaunak Kashyap. </p> </div> <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a> </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../', VERSION:'1.12.1', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <script type="text/javascript" src="../../_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>