����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>Identity v2 — 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"/> <link rel="next" title="Tokens" href="tokens.html"/> <link rel="prev" title="Reverse DNS" href="../dns/reverse-dns.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 class="current"> <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> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#further-links">Further Links</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> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#further-links">Further Links</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> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1 current"><a class="current reference internal" href="">Identity v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../image/index.html">Images v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../image/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../image/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../image/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../image/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../load-balancer/index.html">Load Balancer v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../monitoring/index.html">Monitoring v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../networking/index.html">Networking v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../object-store/index.html">Object Store v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../orchestration/index.html">Orchestration v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../queues/index.html">Queues v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../volume/index.html">Volumes v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#further-links">Further links</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../debugging.html">Debugging</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-1-meaningful-exception-handling">Strategy 1: Meaningful exception handling</a></li> <li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-2-wire-logging">Strategy 2: Wire logging</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../caching-creds.html">Caching credentials</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../caching-creds.html#filesystem-example">Filesystem example</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../iterators.html">Iterators</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#common-behaviour">Common behaviour</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#very-important-note">Very important note</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#using-paginated-collections">Using paginated collections</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#setting-up-a-paginatediterator">Setting up a PaginatedIterator</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../regions.html">Rackspace regions</a></li> <li class="toctree-l1"><a class="reference internal" href="../../url-types.html">URL types</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../url-types.html#internalurl">internalURL</a></li> <li class="toctree-l2"><a class="reference internal" href="../../url-types.html#publicurl">publicURL</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../logging.html">Logging</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../logging.html#logger-injection">Logger injection</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../http-clients.html">HTTP Clients</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#default-http-headers">Default HTTP headers</a></li> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#user-agents">User agents</a></li> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#other-functionality">Other functionality</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../auth.html">Authentication</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../auth.html#service-catalog">Service Catalog</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>Identity v2</li> <li class="wy-breadcrumbs-aside"> <a href="../../_sources/services/identity/index.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main"> <div class="section" id="identity-v2"> <h1>Identity v2<a class="headerlink" href="#identity-v2" title="Permalink to this headline">¶</a></h1> <div class="section" id="setup"> <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> <div class="section" id="rackspace-setup"> <h3>Rackspace setup<a class="headerlink" href="#rackspace-setup" title="Permalink to this headline">¶</a></h3> <p>The first step is to pass in your credentials and set up a client. For Rackspace users, you will need your username and API key:</p> <div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">OpenCloud\Rackspace</span><span class="p">;</span> <span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Rackspace</span><span class="p">(</span><span class="nx">Rackspace</span><span class="o">::</span><span class="na">US_IDENTITY_ENDPOINT</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span> <span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span> <span class="s1">'apiKey'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span> <span class="p">));</span> </pre></div> </div> </div> <div class="section" id="openstack-setup"> <h3>OpenStack setup<a class="headerlink" href="#openstack-setup" title="Permalink to this headline">¶</a></h3> <p>If you’re an OpenStack user, you will also need to prove a few other configuration parameters:</p> <div class="highlight-php"><div class="highlight"><pre><span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">OpenCloud\OpenStack</span><span class="p">(</span><span class="s1">'{keystoneUrl}'</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span> <span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span> <span class="s1">'password'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span> <span class="s1">'tenantId'</span> <span class="o">=></span> <span class="s1">'{tenantId}'</span><span class="p">,</span> <span class="p">));</span> </pre></div> </div> </div> <div class="section" id="identity-service"> <h3>Identity service<a class="headerlink" href="#identity-service" title="Permalink to this headline">¶</a></h3> <p>Now to instantiate the Identity service:</p> <div class="highlight-php"><div class="highlight"><pre><span class="nv">$service</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">identityService</span><span class="p">();</span> </pre></div> </div> </div> </div> <div class="section" id="operations"> <h2>Operations<a class="headerlink" href="#operations" title="Permalink to this headline">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="tokens.html">Tokens</a><ul> <li class="toctree-l2"><a class="reference internal" href="tokens.html#create-token-authenticate">Create token (authenticate)</a><ul> <li class="toctree-l3"><a class="reference internal" href="tokens.html#interacting-with-the-service-catalog">Interacting with the service catalog</a></li> <li class="toctree-l3"><a class="reference internal" href="tokens.html#interacting-with-tokens">Interacting with tokens</a></li> <li class="toctree-l3"><a class="reference internal" href="tokens.html#interacting-with-users">Interacting with users</a></li> <li class="toctree-l3"><a class="reference internal" href="tokens.html#interacting-with-tenants">Interacting with tenants</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="tokens.html#revoke-token-destroy-session">Revoke token (destroy session)</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="users.html">Users</a><ul> <li class="toctree-l2"><a class="reference internal" href="users.html#object-properties-methods">Object properties/methods</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#list-users">List users</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#retrieve-a-user-by-username">Retrieve a user by username</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#retrieve-a-user-by-user-id">Retrieve a user by user ID</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#retrieve-a-user-by-email-address">Retrieve a user by email address</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#create-user">Create user</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#update-user">Update user</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#updating-a-user-password">Updating a user password</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#delete-user">Delete user</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#list-credentials">List credentials</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#get-user-api-key">Get user API key</a></li> <li class="toctree-l2"><a class="reference internal" href="users.html#reset-user-api-key">Reset user API key</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tenants.html">Tenants</a><ul> <li class="toctree-l2"><a class="reference internal" href="tenants.html#list-tenants">List tenants</a></li> <li class="toctree-l2"><a class="reference internal" href="tenants.html#tenant-object-properties-and-methods">Tenant object properties and methods</a></li> </ul> </li> </ul> </div> </div> <div class="section" id="glossary"> <h2>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2> <dl class="glossary docutils"> <dt id="term-token">token</dt> <dd>A token is an opaque string that represents an authorization to access cloud resources. Tokens may be revoked at any time and are valid for a finite duration.</dd> <dt id="term-tenant">tenant</dt> <dd>A tenant is a container used to group or isolate resources and/or identity objects. Depending on the service operator, a tenant may map to a customer, account, organization, or project.</dd> <dt id="term-user">user</dt> <dd>A user is a digital representation of a person, system, or service who consumes cloud services. Users have credentials and may be assigned tokens; based on these credentials and tokens, the authentication service validates that incoming requests are being made by the user who claims to be making the request, and that the user has the right to access the requested resources. Users may be directly assigned to a particular tenant and behave as if they are contained within that tenant.</dd> </dl> </div> <div class="section" id="further-links"> <h2>Further Links<a class="headerlink" href="#further-links" title="Permalink to this headline">¶</a></h2> <ul class="simple"> <li><a class="reference external" href="http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/QuickStart-000.html">Quickstart for the API</a></li> <li><a class="reference external" href="http://docs.rackspace.com/auth/api/v2.0/auth-client-devguide/content/Overview-d1e65.html">API Developer Guide</a></li> </ul> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="tokens.html" class="btn btn-neutral float-right" title="Tokens"/>Next <span class="fa fa-arrow-circle-right"></span></a> <a href="../dns/reverse-dns.html" class="btn btn-neutral" title="Reverse DNS"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <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>