€cdocutils.nodes
document
q)q}q(U	nametypesq}q(X   delete userqNX
   list usersqNX   get user api keyqNX   usersq	NX   setupq
NX    useful object properties/methodsqNX   updating a user passwordqNX   introqNX   get userqNX   list credentialsqNX   update userqNX   create userqNX   reset user api keyqNuUsubstitution_defsq}qUparse_messagesq]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hUdelete-userqhU
list-usersqhUget-user-api-keyqh	Uusersqh
Usetupq hU useful-object-properties-methodsq!hUupdating-a-user-passwordq"hUintroq#hUget-userq$hUlist-credentialsq%hUupdate-userq&hUcreate-userq'hUreset-user-api-keyq(uUchildrenq)]q*cdocutils.nodes
section
q+)q,}q-(U	rawsourceq.U Uparentq/hUsourceq0XJ   /Users/jamie/projects/php/php-opencloud/doc/services/identity/Users.md.rstq1Utagnameq2Usectionq3U
attributesq4}q5(Udupnamesq6]Uclassesq7]Ubackrefsq8]Uidsq9]q:haUnamesq;]q<h	auUlineq=KUdocumentq>hh)]q?(cdocutils.nodes
title
q@)qA}qB(h.X   UsersqCh/h,h0h1h2UtitleqDh4}qE(h6]h7]h8]h9]h;]uh=Kh>hh)]qFcdocutils.nodes
Text
qGX   UsersqH…qI}qJ(h.hCh/hAubaubh+)qK}qL(h.U h/h,h0h1h2h3h4}qM(h6]h7]h8]h9]qNh#ah;]qOhauh=Kh>hh)]qP(h@)qQ}qR(h.X   IntroqSh/hKh0h1h2hDh4}qT(h6]h7]h8]h9]h;]uh=Kh>hh)]qUhGX   IntroqV…qW}qX(h.hSh/hQubaubcdocutils.nodes
paragraph
qY)qZ}q[(h.Xæ  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.q\h/hKh0h1h2U	paragraphq]h4}q^(h6]h7]h8]h9]h;]uh=Kh>hh)]q_hGXæ  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.q`…qa}qb(h.h\h/hZubaubeubh+)qc}qd(h.U h/h,h0h1h2h3h4}qe(h6]h7]h8]h9]qfh ah;]qgh
auh=Kh>hh)]qh(h@)qi}qj(h.X   Setupqkh/hch0h1h2hDh4}ql(h6]h7]h8]h9]h;]uh=Kh>hh)]qmhGX   Setupqn…qo}qp(h.hkh/hiubaubhY)qq}qr(h.Xq   User objects are instantiated from the Identity service. For more
details, see the `Service <Service.md>`__ docs.h/hch0h1h2h]h4}qs(h6]h7]h8]h9]h;]uh=Kh>hh)]qt(hGXS   User objects are instantiated from the Identity service. For more
details, see the qu…qv}qw(h.XS   User objects are instantiated from the Identity service. For more
details, see the h/hqubcdocutils.nodes
reference
qx)qy}qz(h.X   `Service <Service.md>`__h4}q{(UnameX   ServiceUrefuriq|X
   Service.mdh9]h8]h6]h7]h;]uh/hqh)]q}hGX   Serviceq~…q}q€(h.U h/hyubah2U	referencequbhGX    docs.q‚…qƒ}q„(h.X    docs.h/hqubeubeubh+)q…}q†(h.U h/h,h0h1h2h3h4}q‡(h6]h7]h8]h9]qˆh!ah;]q‰hauh=Kh>hh)]qŠ(h@)q‹}qŒ(h.X    Useful object properties/methodsqh/h…h0h1h2hDh4}qŽ(h6]h7]h8]h9]h;]uh=Kh>hh)]qhGX    Useful object properties/methodsq…q‘}q’(h.hh/h‹ubaubcdocutils.nodes
table
q“)q”}q•(h.U h/h…h0h1h2Utableq–h4}q—(h6]h7]h8]h9]h;]uh=Nh>hh)]q˜cdocutils.nodes
tgroup
q™)qš}q›(h.U h4}qœ(h9]h8]h6]h7]h;]UcolsKuh/h”h)]q(cdocutils.nodes
colspec
qž)qŸ}q (h.U h4}q¡(h9]h8]h6]h7]h;]UcolwidthKuh/hšh)]h2Ucolspecq¢ubhž)q£}q¤(h.U h4}q¥(h9]h8]h6]h7]h;]UcolwidthM?uh/hšh)]h2h¢ubhž)q¦}q§(h.U h4}q¨(h9]h8]h6]h7]h;]UcolwidthK,uh/hšh)]h2h¢ubhž)q©}qª(h.U h4}q«(h9]h8]h6]h7]h;]UcolwidthKouh/hšh)]h2h¢ubcdocutils.nodes
thead
q¬)q­}q®(h.U h4}q¯(h6]h7]h8]h9]h;]uh/hšh)]q°cdocutils.nodes
row
q±)q²}q³(h.U h4}q´(h6]h7]h8]h9]h;]uh/h­h)]qµ(cdocutils.nodes
entry
q¶)q·}q¸(h.U h4}q¹(h6]h7]h8]h9]h;]uh/h²h)]qºhY)q»}q¼(h.X   Propertyq½h/h·h0h1h2h]h4}q¾(h6]h7]h8]h9]h;]uh=Kh)]q¿hGX   PropertyqÀ…qÁ}qÂ(h.h½h/h»ubaubah2UentryqÃubh¶)qÄ}qÅ(h.U h4}qÆ(h6]h7]h8]h9]h;]uh/h²h)]qÇhY)qÈ}qÉ(h.X   DescriptionqÊh/hÄh0h1h2h]h4}qË(h6]h7]h8]h9]h;]uh=Kh)]qÌhGX   DescriptionqÍ…qÎ}qÏ(h.hÊh/hÈubaubah2hÃubh¶)qÐ}qÑ(h.U h4}qÒ(h6]h7]h8]h9]h;]uh/h²h)]qÓhY)qÔ}qÕ(h.X   GetterqÖh/hÐh0h1h2h]h4}q×(h6]h7]h8]h9]h;]uh=Kh)]qØhGX   GetterqÙ…qÚ}qÛ(h.hÖh/hÔubaubah2hÃubh¶)qÜ}qÝ(h.U h4}qÞ(h6]h7]h8]h9]h;]uh/h²h)]qßhY)qà}qá(h.X   Setterqâh/hÜh0h1h2h]h4}qã(h6]h7]h8]h9]h;]uh=Kh)]qähGX   Setterqå…qæ}qç(h.hâh/hàubaubah2hÃubeh2Urowqèubah2Utheadqéubcdocutils.nodes
tbody
qê)që}qì(h.U h4}qí(h6]h7]h8]h9]h;]uh/hšh)]qî(h±)qï}qð(h.U h4}qñ(h6]h7]h8]h9]h;]uh/hëh)]qò(h¶)qó}qô(h.U h4}qõ(h6]h7]h8]h9]h;]uh/hïh)]qöhY)q÷}qø(h.X   idqùh/hóh0h1h2h]h4}qú(h6]h7]h8]h9]h;]uh=Kh)]qûhGX   idqü…qý}qþ(h.hùh/h÷ubaubah2hÃubh¶)qÿ}r   (h.U h4}r  (h6]h7]h8]h9]h;]uh/hïh)]r  hY)r  }r  (h.X   The unique ID for this userr  h/hÿh0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=Kh)]r  hGX   The unique ID for this userr  …r	  }r
  (h.j  h/j  ubaubah2hÃubh¶)r  }r  (h.U h4}r  (h6]h7]h8]h9]h;]uh/hïh)]r  hY)r  }r  (h.X   ``getId()``r  h/j  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=Kh)]r  cdocutils.nodes
literal
r  )r  }r  (h.j  h4}r  (h6]h7]h8]h9]h;]uh/j  h)]r  hGX   getId()r  …r  }r  (h.U h/j  ubah2Uliteralr  ubaubah2hÃubh¶)r  }r  (h.U h4}r  (h6]h7]h8]h9]h;]uh/hïh)]r   hY)r!  }r"  (h.X   ``setId()``r#  h/j  h0h1h2h]h4}r$  (h6]h7]h8]h9]h;]uh=Kh)]r%  j  )r&  }r'  (h.j#  h4}r(  (h6]h7]h8]h9]h;]uh/j!  h)]r)  hGX   setId()r*  …r+  }r,  (h.U h/j&  ubah2j  ubaubah2hÃubeh2hèubh±)r-  }r.  (h.U h4}r/  (h6]h7]h8]h9]h;]uh/hëh)]r0  (h¶)r1  }r2  (h.U h4}r3  (h6]h7]h8]h9]h;]uh/j-  h)]r4  hY)r5  }r6  (h.X   usernamer7  h/j1  h0h1h2h]h4}r8  (h6]h7]h8]h9]h;]uh=Kh)]r9  hGX   usernamer:  …r;  }r<  (h.j7  h/j5  ubaubah2hÃubh¶)r=  }r>  (h.U h4}r?  (h6]h7]h8]h9]h;]uh/j-  h)]r@  hY)rA  }rB  (h.X   Username for this userrC  h/j=  h0h1h2h]h4}rD  (h6]h7]h8]h9]h;]uh=Kh)]rE  hGX   Username for this userrF  …rG  }rH  (h.jC  h/jA  ubaubah2hÃubh¶)rI  }rJ  (h.U h4}rK  (h6]h7]h8]h9]h;]uh/j-  h)]rL  hY)rM  }rN  (h.X   ``getUsername()``rO  h/jI  h0h1h2h]h4}rP  (h6]h7]h8]h9]h;]uh=Kh)]rQ  j  )rR  }rS  (h.jO  h4}rT  (h6]h7]h8]h9]h;]uh/jM  h)]rU  hGX   getUsername()rV  …rW  }rX  (h.U h/jR  ubah2j  ubaubah2hÃubh¶)rY  }rZ  (h.U h4}r[  (h6]h7]h8]h9]h;]uh/j-  h)]r\  hY)r]  }r^  (h.X   ``setUsername()``r_  h/jY  h0h1h2h]h4}r`  (h6]h7]h8]h9]h;]uh=Kh)]ra  j  )rb  }rc  (h.j_  h4}rd  (h6]h7]h8]h9]h;]uh/j]  h)]re  hGX   setUsername()rf  …rg  }rh  (h.U h/jb  ubah2j  ubaubah2hÃubeh2hèubh±)ri  }rj  (h.U h4}rk  (h6]h7]h8]h9]h;]uh/hëh)]rl  (h¶)rm  }rn  (h.U h4}ro  (h6]h7]h8]h9]h;]uh/ji  h)]rp  hY)rq  }rr  (h.X   emailrs  h/jm  h0h1h2h]h4}rt  (h6]h7]h8]h9]h;]uh=K h)]ru  hGX   emailrv  …rw  }rx  (h.js  h/jq  ubaubah2hÃubh¶)ry  }rz  (h.U h4}r{  (h6]h7]h8]h9]h;]uh/ji  h)]r|  hY)r}  }r~  (h.X   User's email addressr  h/jy  h0h1h2h]h4}r€  (h6]h7]h8]h9]h;]uh=K h)]r  hGX   User's email addressr‚  …rƒ  }r„  (h.j  h/j}  ubaubah2hÃubh¶)r…  }r†  (h.U h4}r‡  (h6]h7]h8]h9]h;]uh/ji  h)]rˆ  hY)r‰  }rŠ  (h.X   ``getEmail()``r‹  h/j…  h0h1h2h]h4}rŒ  (h6]h7]h8]h9]h;]uh=K h)]r  j  )rŽ  }r  (h.j‹  h4}r  (h6]h7]h8]h9]h;]uh/j‰  h)]r‘  hGX
   getEmail()r’  …r“  }r”  (h.U h/jŽ  ubah2j  ubaubah2hÃubh¶)r•  }r–  (h.U h4}r—  (h6]h7]h8]h9]h;]uh/ji  h)]r˜  hY)r™  }rš  (h.X   ``setEmail()``r›  h/j•  h0h1h2h]h4}rœ  (h6]h7]h8]h9]h;]uh=K h)]r  j  )rž  }rŸ  (h.j›  h4}r   (h6]h7]h8]h9]h;]uh/j™  h)]r¡  hGX
   setEmail()r¢  …r£  }r¤  (h.U h/jž  ubah2j  ubaubah2hÃubeh2hèubh±)r¥  }r¦  (h.U h4}r§  (h6]h7]h8]h9]h;]uh/hëh)]r¨  (h¶)r©  }rª  (h.U h4}r«  (h6]h7]h8]h9]h;]uh/j¥  h)]r¬  hY)r­  }r®  (h.X   enabledr¯  h/j©  h0h1h2h]h4}r°  (h6]h7]h8]h9]h;]uh=K"h)]r±  hGX   enabledr²  …r³  }r´  (h.j¯  h/j­  ubaubah2hÃubh¶)rµ  }r¶  (h.U h4}r·  (h6]h7]h8]h9]h;]uh/j¥  h)]r¸  hY)r¹  }rº  (h.X6   Whether or not this user can consume API functionalityr»  h/jµ  h0h1h2h]h4}r¼  (h6]h7]h8]h9]h;]uh=K"h)]r½  hGX6   Whether or not this user can consume API functionalityr¾  …r¿  }rÀ  (h.j»  h/j¹  ubaubah2hÃubh¶)rÁ  }rÂ  (h.U h4}rÃ  (h6]h7]h8]h9]h;]uh/j¥  h)]rÄ  hY)rÅ  }rÆ  (h.X#   ``getEnabled()`` or ``isEnabled()``h/jÁ  h0h1h2h]h4}rÇ  (h6]h7]h8]h9]h;]uh=K"h)]rÈ  (j  )rÉ  }rÊ  (h.X   ``getEnabled()``h4}rË  (h6]h7]h8]h9]h;]uh/jÅ  h)]rÌ  hGX   getEnabled()rÍ  …rÎ  }rÏ  (h.U h/jÉ  ubah2j  ubhGX    or rÐ  …rÑ  }rÒ  (h.X    or h/jÅ  ubj  )rÓ  }rÔ  (h.X   ``isEnabled()``h4}rÕ  (h6]h7]h8]h9]h;]uh/jÅ  h)]rÖ  hGX   isEnabled()r×  …rØ  }rÙ  (h.U h/jÓ  ubah2j  ubeubah2hÃubh¶)rÚ  }rÛ  (h.U h4}rÜ  (h6]h7]h8]h9]h;]uh/j¥  h)]rÝ  hY)rÞ  }rß  (h.X   ``setEnabled()``rà  h/jÚ  h0h1h2h]h4}rá  (h6]h7]h8]h9]h;]uh=K"h)]râ  j  )rã  }rä  (h.jà  h4}rå  (h6]h7]h8]h9]h;]uh/jÞ  h)]ræ  hGX   setEnabled()rç  …rè  }ré  (h.U h/jã  ubah2j  ubaubah2hÃubeh2hèubh±)rê  }rë  (h.U h4}rì  (h6]h7]h8]h9]h;]uh/hëh)]rí  (h¶)rî  }rï  (h.U h4}rð  (h6]h7]h8]h9]h;]uh/jê  h)]rñ  hY)rò  }ró  (h.X   passwordrô  h/jî  h0h1h2h]h4}rõ  (h6]h7]h8]h9]h;]uh=K$h)]rö  hGX   passwordr÷  …rø  }rù  (h.jô  h/jò  ubaubah2hÃubh¶)rú  }rû  (h.U h4}rü  (h6]h7]h8]h9]h;]uh/jê  h)]rý  hY)rþ  }rÿ  (h.Xl   Either a user-defined string, or an automatically generated one, that provides security when authenticating.r   h/jú  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=K$h)]r  hGXl   Either a user-defined string, or an automatically generated one, that provides security when authenticating.r  …r  }r  (h.j   h/jþ  ubaubah2hÃubh¶)r  }r  (h.U h4}r  (h6]h7]h8]h9]h;]uh/jê  h)]r	  hY)r
  }r  (h.X(   ``getPassword()`` only valid on creationh/j  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=K$h)]r  (j  )r  }r  (h.X   ``getPassword()``h4}r  (h6]h7]h8]h9]h;]uh/j
  h)]r  hGX   getPassword()r  …r  }r  (h.U h/j  ubah2j  ubhGX    only valid on creationr  …r  }r  (h.X    only valid on creationh/j
  ubeubah2hÃubh¶)r  }r  (h.U h4}r  (h6]h7]h8]h9]h;]uh/jê  h)]r  hY)r  }r  (h.Xk   ``setPassword()`` to set local property only. To set password on API (retention), use ``updatePassword()``.h/j  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=K$h)]r  (j  )r   }r!  (h.X   ``setPassword()``h4}r"  (h6]h7]h8]h9]h;]uh/j  h)]r#  hGX   setPassword()r$  …r%  }r&  (h.U h/j   ubah2j  ubhGXE    to set local property only. To set password on API (retention), use r'  …r(  }r)  (h.XE    to set local property only. To set password on API (retention), use h/j  ubj  )r*  }r+  (h.X   ``updatePassword()``h4}r,  (h6]h7]h8]h9]h;]uh/j  h)]r-  hGX   updatePassword()r.  …r/  }r0  (h.U h/j*  ubah2j  ubhGX   .…r1  }r2  (h.X   .h/j  ubeubah2hÃubeh2hèubh±)r3  }r4  (h.U h4}r5  (h6]h7]h8]h9]h;]uh/hëh)]r6  (h¶)r7  }r8  (h.U h4}r9  (h6]h7]h8]h9]h;]uh/j3  h)]r:  hY)r;  }r<  (h.X   defaultRegionr=  h/j7  h0h1h2h]h4}r>  (h6]h7]h8]h9]h;]uh=K&h)]r?  hGX   defaultRegionr@  …rA  }rB  (h.j=  h/j;  ubaubah2hÃubh¶)rC  }rD  (h.U h4}rE  (h6]h7]h8]h9]h;]uh/j3  h)]rF  hY)rG  }rH  (h.X  Default region associates a user with a specific regional datacenter. If a default region has been assigned for this user and that user has **NOT** explicitly specified a region when creating a service object, the user will obtain the service from the default region.h/jC  h0h1h2h]h4}rI  (h6]h7]h8]h9]h;]uh=K&h)]rJ  (hGXŒ   Default region associates a user with a specific regional datacenter. If a default region has been assigned for this user and that user has rK  …rL  }rM  (h.XŒ   Default region associates a user with a specific regional datacenter. If a default region has been assigned for this user and that user has h/jG  ubcdocutils.nodes
strong
rN  )rO  }rP  (h.X   **NOT**h4}rQ  (h6]h7]h8]h9]h;]uh/jG  h)]rR  hGX   NOTrS  …rT  }rU  (h.U h/jO  ubah2UstrongrV  ubhGXx    explicitly specified a region when creating a service object, the user will obtain the service from the default region.rW  …rX  }rY  (h.Xx    explicitly specified a region when creating a service object, the user will obtain the service from the default region.h/jG  ubeubah2hÃubh¶)rZ  }r[  (h.U h4}r\  (h6]h7]h8]h9]h;]uh/j3  h)]r]  hY)r^  }r_  (h.X   ``getDefaultRegion()``r`  h/jZ  h0h1h2h]h4}ra  (h6]h7]h8]h9]h;]uh=K&h)]rb  j  )rc  }rd  (h.j`  h4}re  (h6]h7]h8]h9]h;]uh/j^  h)]rf  hGX   getDefaultRegion()rg  …rh  }ri  (h.U h/jc  ubah2j  ubaubah2hÃubh¶)rj  }rk  (h.U h4}rl  (h6]h7]h8]h9]h;]uh/j3  h)]rm  hY)rn  }ro  (h.X   ``setDefaultRegion()``rp  h/jj  h0h1h2h]h4}rq  (h6]h7]h8]h9]h;]uh=K&h)]rr  j  )rs  }rt  (h.jp  h4}ru  (h6]h7]h8]h9]h;]uh/jn  h)]rv  hGX   setDefaultRegion()rw  …rx  }ry  (h.U h/js  ubah2j  ubaubah2hÃubeh2hèubh±)rz  }r{  (h.U h4}r|  (h6]h7]h8]h9]h;]uh/hëh)]r}  (h¶)r~  }r  (h.U h4}r€  (h6]h7]h8]h9]h;]uh/jz  h)]r  hY)r‚  }rƒ  (h.X   domainIdr„  h/j~  h0h1h2h]h4}r…  (h6]h7]h8]h9]h;]uh=K(h)]r†  hGX   domainIdr‡  …rˆ  }r‰  (h.j„  h/j‚  ubaubah2hÃubh¶)rŠ  }r‹  (h.U h4}rŒ  (h6]h7]h8]h9]h;]uh/jz  h)]r  hY)rŽ  }r  (h.X;  Domain ID associates a user with a specific domain which was assigned when the user was created or updated. A domain establishes an administrative boundary for a customer and a container for a customer's tenants (accounts) and users. Generally, a domainId is the same as the primary tenant id of your cloud account.r  h/jŠ  h0h1h2h]h4}r‘  (h6]h7]h8]h9]h;]uh=K(h)]r’  hGX;  Domain ID associates a user with a specific domain which was assigned when the user was created or updated. A domain establishes an administrative boundary for a customer and a container for a customer's tenants (accounts) and users. Generally, a domainId is the same as the primary tenant id of your cloud account.r“  …r”  }r•  (h.j  h/jŽ  ubaubah2hÃubh¶)r–  }r—  (h.U h4}r˜  (h6]h7]h8]h9]h;]uh/jz  h)]r™  hY)rš  }r›  (h.X   ``getDomainId()``rœ  h/j–  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=K(h)]rž  j  )rŸ  }r   (h.jœ  h4}r¡  (h6]h7]h8]h9]h;]uh/jš  h)]r¢  hGX   getDomainId()r£  …r¤  }r¥  (h.U h/jŸ  ubah2j  ubaubah2hÃubh¶)r¦  }r§  (h.U h4}r¨  (h6]h7]h8]h9]h;]uh/jz  h)]r©  hY)rª  }r«  (h.X   ``setDomainId()``r¬  h/j¦  h0h1h2h]h4}r­  (h6]h7]h8]h9]h;]uh=K(h)]r®  j  )r¯  }r°  (h.j¬  h4}r±  (h6]h7]h8]h9]h;]uh/jª  h)]r²  hGX   setDomainId()r³  …r´  }rµ  (h.U h/j¯  ubah2j  ubaubah2hÃubeh2hèubeh2Utbodyr¶  ubeh2Utgroupr·  ubaubeubh+)r¸  }r¹  (h.U h/h,h0h1h2h3h4}rº  (h6]h7]h8]h9]r»  hah;]r¼  hauh=K,h>hh)]r½  (h@)r¾  }r¿  (h.X
   List usersrÀ  h/j¸  h0h1h2hDh4}rÁ  (h6]h7]h8]h9]h;]uh=K,h>hh)]rÂ  hGX
   List usersrÃ  …rÄ  }rÅ  (h.jÀ  h/j¾  ubaubcdocutils.nodes
literal_block
rÆ  )rÇ  }rÈ  (h.XG   $users = $service->getUsers();

foreach ($users as $user) {
   // ...
}h/j¸  h0h1h2Uliteral_blockrÉ  h4}rÊ  (U	xml:spacerË  UpreserverÌ  h9]h8]h6]h7]rÍ  (UcoderÎ  X   phprÏ  eh;]uh=K5h>hh)]rÐ  cdocutils.nodes
inline
rÑ  )rÒ  }rÓ  (h.XG   $users = $service->getUsers();

foreach ($users as $user) {
   // ...
}h4}rÔ  (h6]h7]rÕ  UotherrÖ  ah8]h9]h;]uh/jÇ  h)]r×  hGXG   $users = $service->getUsers();

foreach ($users as $user) {
   // ...
}rØ  …rÙ  }rÚ  (h.U h/jÒ  ubah2UinlinerÛ  ubaubhY)rÜ  }rÝ  (h.X]   For more information about how to use iterators, see the
`documentation <../Iterators.md>`__.h/j¸  h0h1h2h]h4}rÞ  (h6]h7]h8]h9]h;]uh=K6h>hh)]rß  (hGX9   For more information about how to use iterators, see the
rà  …rá  }râ  (h.X9   For more information about how to use iterators, see the
h/jÜ  ubhx)rã  }rä  (h.X#   `documentation <../Iterators.md>`__h4}rå  (UnameX   documentationh|X   ../Iterators.mdh9]h8]h6]h7]h;]uh/jÜ  h)]ræ  hGX   documentationrç  …rè  }ré  (h.U h/jã  ubah2hubhGX   .…rê  }rë  (h.X   .h/jÜ  ubeubeubh+)rì  }rí  (h.U h/h,h0h1h2h3h4}rî  (h6]h7]h8]h9]rï  h$ah;]rð  hauh=K:h>hh)]rñ  (h@)rò  }ró  (h.X   Get userrô  h/jì  h0h1h2hDh4}rõ  (h6]h7]h8]h9]h;]uh=K:h>hh)]rö  hGX   Get userr÷  …rø  }rù  (h.jô  h/jò  ubaubhY)rú  }rû  (h.XM   There are various ways to get a specific user: by name, ID and email
address.rü  h/jì  h0h1h2h]h4}rý  (h6]h7]h8]h9]h;]uh=K<h>hh)]rþ  hGXM   There are various ways to get a specific user: by name, ID and email
address.rÿ  …r   }r  (h.jü  h/jú  ubaubjÆ  )r  }r  (h.X"  use OpenCloud\Identity\Constants\User as UserConst;

// Get user by name
$user1 = $service->getUser('jamie');

// Get user by ID
$user2 = $service->getUser(123456, UserConst::MODE_ID);

// Get user by email
$user3 = $service->getUser('jamie.hannaford@rackspace.com', UserConst::MODE_EMAIL);h/jì  h0h1h2jÉ  h4}r  (jË  jÌ  h9]h8]h6]h7]r  (jÎ  X   phpr  eh;]uh=KKh>hh)]r  jÑ  )r  }r	  (h.X"  use OpenCloud\Identity\Constants\User as UserConst;

// Get user by name
$user1 = $service->getUser('jamie');

// Get user by ID
$user2 = $service->getUser(123456, UserConst::MODE_ID);

// Get user by email
$user3 = $service->getUser('jamie.hannaford@rackspace.com', UserConst::MODE_EMAIL);h4}r
  (h6]h7]r  Uotherr  ah8]h9]h;]uh/j  h)]r  hGX"  use OpenCloud\Identity\Constants\User as UserConst;

// Get user by name
$user1 = $service->getUser('jamie');

// Get user by ID
$user2 = $service->getUser(123456, UserConst::MODE_ID);

// Get user by email
$user3 = $service->getUser('jamie.hannaford@rackspace.com', UserConst::MODE_EMAIL);r  …r  }r  (h.U h/j  ubah2jÛ  ubaubeubh+)r  }r  (h.U h/h,h0h1h2h3h4}r  (h6]h7]h8]h9]r  h'ah;]r  hauh=KMh>hh)]r  (h@)r  }r  (h.X   Create userr  h/j  h0h1h2hDh4}r  (h6]h7]h8]h9]h;]uh=KMh>hh)]r  hGX   Create userr  …r  }r  (h.j  h/j  ubaubhY)r  }r   (h.X8   There are a few things to remember when creating a user:r!  h/j  h0h1h2h]h4}r"  (h6]h7]h8]h9]h;]uh=KOh>hh)]r#  hGX8   There are a few things to remember when creating a user:r$  …r%  }r&  (h.j!  h/j  ubaubcdocutils.nodes
bullet_list
r'  )r(  }r)  (h.U h/j  h0h1h2Ubullet_listr*  h4}r+  (Ubulletr,  X   -h9]h8]h6]h7]h;]uh=KQh>hh)]r-  (cdocutils.nodes
list_item
r.  )r/  }r0  (h.X    This operation is available only to users who hold the
``identity:user-admin`` role. This admin can create a user who holds
the ``identity:default`` user role.
h/j(  h0h1h2U	list_itemr1  h4}r2  (h6]h7]h8]h9]h;]uh=Nh>hh)]r3  hY)r4  }r5  (h.XŸ   This operation is available only to users who hold the
``identity:user-admin`` role. This admin can create a user who holds
the ``identity:default`` user role.h/j/  h0h1h2h]h4}r6  (h6]h7]h8]h9]h;]uh=KQh)]r7  (hGX7   This operation is available only to users who hold the
r8  …r9  }r:  (h.X7   This operation is available only to users who hold the
h/j4  ubj  )r;  }r<  (h.X   ``identity:user-admin``h4}r=  (h6]h7]h8]h9]h;]uh/j4  h)]r>  hGX   identity:user-adminr?  …r@  }rA  (h.U h/j;  ubah2j  ubhGX2    role. This admin can create a user who holds
the rB  …rC  }rD  (h.X2    role. This admin can create a user who holds
the h/j4  ubj  )rE  }rF  (h.X   ``identity:default``h4}rG  (h6]h7]h8]h9]h;]uh/j4  h)]rH  hGX   identity:defaultrI  …rJ  }rK  (h.U h/jE  ubah2j  ubhGX    user role.rL  …rM  }rN  (h.X    user role.h/j4  ubeubaubj.  )rO  }rP  (h.Xg   The created user **will** have access to APIs but **will not** have
access to the Cloud Control Panel.
h/j(  h0h1h2j1  h4}rQ  (h6]h7]h8]h9]h;]uh=Nh>hh)]rR  hY)rS  }rT  (h.Xf   The created user **will** have access to APIs but **will not** have
access to the Cloud Control Panel.h/jO  h0h1h2h]h4}rU  (h6]h7]h8]h9]h;]uh=KUh)]rV  (hGX   The created user rW  …rX  }rY  (h.X   The created user h/jS  ubjN  )rZ  }r[  (h.X   **will**h4}r\  (h6]h7]h8]h9]h;]uh/jS  h)]r]  hGX   willr^  …r_  }r`  (h.U h/jZ  ubah2jV  ubhGX    have access to APIs but ra  …rb  }rc  (h.X    have access to APIs but h/jS  ubjN  )rd  }re  (h.X   **will not**h4}rf  (h6]h7]h8]h9]h;]uh/jS  h)]rg  hGX   will notrh  …ri  }rj  (h.U h/jd  ubah2jV  ubhGX(    have
access to the Cloud Control Panel.rk  …rl  }rm  (h.X(    have
access to the Cloud Control Panel.h/jS  ubeubaubj.  )rn  }ro  (h.X@   Within an account, a maximum of 100 account users can be added.
h/j(  h0h1h2j1  h4}rp  (h6]h7]h8]h9]h;]uh=Nh>hh)]rq  hY)rr  }rs  (h.X?   Within an account, a maximum of 100 account users can be added.rt  h/jn  h0h1h2h]h4}ru  (h6]h7]h8]h9]h;]uh=KXh)]rv  hGX?   Within an account, a maximum of 100 account users can be added.rw  …rx  }ry  (h.jt  h/jr  ubaubaubj.  )rz  }r{  (h.XL   If you attempt to add a user who already exists, an HTTP error 409
results.
h/j(  h0h1h2j1  h4}r|  (h6]h7]h8]h9]h;]uh=Nh>hh)]r}  hY)r~  }r  (h.XK   If you attempt to add a user who already exists, an HTTP error 409
results.r€  h/jz  h0h1h2h]h4}r  (h6]h7]h8]h9]h;]uh=KZh)]r‚  hGXK   If you attempt to add a user who already exists, an HTTP error 409
results.rƒ  …r„  }r…  (h.j€  h/j~  ubaubaubeubhY)r†  }r‡  (h.X¿   The ``username`` and ``email`` properties are required for creating a
user. Providing a ``password`` is optional; if omitted, one will be
automatically generated and provided in the response.h/j  h0h1h2h]h4}rˆ  (h6]h7]h8]h9]h;]uh=K]h>hh)]r‰  (hGX   The rŠ  …r‹  }rŒ  (h.X   The h/j†  ubj  )r  }rŽ  (h.X   ``username``h4}r  (h6]h7]h8]h9]h;]uh/j†  h)]r  hGX   usernamer‘  …r’  }r“  (h.U h/j  ubah2j  ubhGX    and r”  …r•  }r–  (h.X    and h/j†  ubj  )r—  }r˜  (h.X	   ``email``h4}r™  (h6]h7]h8]h9]h;]uh/j†  h)]rš  hGX   emailr›  …rœ  }r  (h.U h/j—  ubah2j  ubhGX:    properties are required for creating a
user. Providing a rž  …rŸ  }r   (h.X:    properties are required for creating a
user. Providing a h/j†  ubj  )r¡  }r¢  (h.X   ``password``h4}r£  (h6]h7]h8]h9]h;]uh/j†  h)]r¤  hGX   passwordr¥  …r¦  }r§  (h.U h/j¡  ubah2j  ubhGX[    is optional; if omitted, one will be
automatically generated and provided in the response.r¨  …r©  }rª  (h.X[    is optional; if omitted, one will be
automatically generated and provided in the response.h/j†  ubeubjÆ  )r«  }r¬  (h.Xm  use Guzzle\Http\Exception\ClientErrorResponseException;

try {
   // execute operation
   $user = $service->createUser(array(
      'username' => 'newUser',
      'email'    => 'foo@bar.com'
   ));
} catch (ClientErrorResponseException $e) {
   // catch 4xx HTTP errors
   echo $e->getResponse()->toString();
}

// show generated password
echo $user->getPassword();h/j  h0h1h2jÉ  h4}r­  (jË  jÌ  h9]h8]h6]h7]r®  (jÎ  X   phpr¯  eh;]uh=Krh>hh)]r°  jÑ  )r±  }r²  (h.Xm  use Guzzle\Http\Exception\ClientErrorResponseException;

try {
   // execute operation
   $user = $service->createUser(array(
      'username' => 'newUser',
      'email'    => 'foo@bar.com'
   ));
} catch (ClientErrorResponseException $e) {
   // catch 4xx HTTP errors
   echo $e->getResponse()->toString();
}

// show generated password
echo $user->getPassword();h4}r³  (h6]h7]r´  Uotherrµ  ah8]h9]h;]uh/j«  h)]r¶  hGXm  use Guzzle\Http\Exception\ClientErrorResponseException;

try {
   // execute operation
   $user = $service->createUser(array(
      'username' => 'newUser',
      'email'    => 'foo@bar.com'
   ));
} catch (ClientErrorResponseException $e) {
   // catch 4xx HTTP errors
   echo $e->getResponse()->toString();
}

// show generated password
echo $user->getPassword();r·  …r¸  }r¹  (h.U h/j±  ubah2jÛ  ubaubeubh+)rº  }r»  (h.U h/h,h0h1h2h3h4}r¼  (h6]h7]h8]h9]r½  h&ah;]r¾  hauh=Kth>hh)]r¿  (h@)rÀ  }rÁ  (h.X   Update userrÂ  h/jº  h0h1h2hDh4}rÃ  (h6]h7]h8]h9]h;]uh=Kth>hh)]rÄ  hGX   Update userrÅ  …rÆ  }rÇ  (h.jÂ  h/jÀ  ubaubhY)rÈ  }rÉ  (h.XJ   When updating a user, specify which attribute/property you want to
update:rÊ  h/jº  h0h1h2h]h4}rË  (h6]h7]h8]h9]h;]uh=Kvh>hh)]rÌ  hGXJ   When updating a user, specify which attribute/property you want to
update:rÍ  …rÎ  }rÏ  (h.jÊ  h/jÈ  ubaubjÆ  )rÐ  }rÑ  (h.X:   $user->update(array(
   'email' => 'new_email@bar.com'
));h/jº  h0h1h2jÉ  h4}rÒ  (jË  jÌ  h9]h8]h6]h7]rÓ  (jÎ  X   phprÔ  eh;]uh=K~h>hh)]rÕ  jÑ  )rÖ  }r×  (h.X:   $user->update(array(
   'email' => 'new_email@bar.com'
));h4}rØ  (h6]h7]rÙ  UotherrÚ  ah8]h9]h;]uh/jÐ  h)]rÛ  hGX:   $user->update(array(
   'email' => 'new_email@bar.com'
));rÜ  …rÝ  }rÞ  (h.U h/jÖ  ubah2jÛ  ubaubh+)rß  }rà  (h.U h/jº  h0h1h2h3h4}rá  (h6]h7]h8]h9]râ  h"ah;]rã  hauh=K€h>hh)]rä  (h@)rå  }ræ  (h.X   Updating a user passwordrç  h/jß  h0h1h2hDh4}rè  (h6]h7]h8]h9]h;]uh=K€h>hh)]ré  hGX   Updating a user passwordrê  …rë  }rì  (h.jç  h/jå  ubaubhY)rí  }rî  (h.X<   Updating a user password requires calling a distinct method:rï  h/jß  h0h1h2h]h4}rð  (h6]h7]h8]h9]h;]uh=K‚h>hh)]rñ  hGX<   Updating a user password requires calling a distinct method:rò  …ró  }rô  (h.jï  h/jí  ubaubjÆ  )rõ  }rö  (h.X%   $user->updatePassword('password123');h/jß  h0h1h2jÉ  h4}r÷  (jË  jÌ  h9]h8]h6]h7]rø  (jÎ  X   phprù  eh;]uh=K‡h>hh)]rú  jÑ  )rû  }rü  (h.X%   $user->updatePassword('password123');h4}rý  (h6]h7]rþ  Uotherrÿ  ah8]h9]h;]uh/jõ  h)]r   hGX%   $user->updatePassword('password123');r  …r  }r  (h.U h/jû  ubah2jÛ  ubaubeubeubh+)r  }r  (h.U h/h,h0h1h2h3h4}r  (h6]h7]h8]h9]r  hah;]r  hauh=K‰h>hh)]r	  (h@)r
  }r  (h.X   Delete userr  h/j  h0h1h2hDh4}r  (h6]h7]h8]h9]h;]uh=K‰h>hh)]r  hGX   Delete userr  …r  }r  (h.j  h/j
  ubaubjÆ  )r  }r  (h.X   $user->delete();h/j  h0h1h2jÉ  h4}r  (jË  jÌ  h9]h8]h6]h7]r  (jÎ  X   phpr  eh;]uh=KŽh>hh)]r  jÑ  )r  }r  (h.X   $user->delete();h4}r  (h6]h7]r  Uotherr  ah8]h9]h;]uh/j  h)]r  hGX   $user->delete();r  …r  }r   (h.U h/j  ubah2jÛ  ubaubeubh+)r!  }r"  (h.U h/h,h0h1h2h3h4}r#  (h6]h7]h8]h9]r$  h%ah;]r%  hauh=Kh>hh)]r&  (h@)r'  }r(  (h.X   List credentialsr)  h/j!  h0h1h2hDh4}r*  (h6]h7]h8]h9]h;]uh=Kh>hh)]r+  hGX   List credentialsr,  …r-  }r.  (h.j)  h/j'  ubaubhY)r/  }r0  (h.Xm   This operation allows you to see your non-password credential types for
all authentication methods available.r1  h/j!  h0h1h2h]h4}r2  (h6]h7]h8]h9]h;]uh=K’h>hh)]r3  hGXm   This operation allows you to see your non-password credential types for
all authentication methods available.r4  …r5  }r6  (h.j1  h/j/  ubaubjÆ  )r7  }r8  (h.X&   $creds = $user->getOtherCredentials();h/j!  h0h1h2jÉ  h4}r9  (jË  jÌ  h9]h8]h6]h7]r:  (jÎ  X   phpr;  eh;]uh=K˜h>hh)]r<  jÑ  )r=  }r>  (h.X&   $creds = $user->getOtherCredentials();h4}r?  (h6]h7]r@  UotherrA  ah8]h9]h;]uh/j7  h)]rB  hGX&   $creds = $user->getOtherCredentials();rC  …rD  }rE  (h.U h/j=  ubah2jÛ  ubaubeubh+)rF  }rG  (h.U h/h,h0h1h2h3h4}rH  (h6]h7]h8]h9]rI  hah;]rJ  hauh=Kšh>hh)]rK  (h@)rL  }rM  (h.X   Get user API keyrN  h/jF  h0h1h2hDh4}rO  (h6]h7]h8]h9]h;]uh=Kšh>hh)]rP  hGX   Get user API keyrQ  …rR  }rS  (h.jN  h/jL  ubaubjÆ  )rT  }rU  (h.X   echo $user->getApiKey();h/jF  h0h1h2jÉ  h4}rV  (jË  jÌ  h9]h8]h6]h7]rW  (jÎ  X   phprX  eh;]uh=KŸh>hh)]rY  jÑ  )rZ  }r[  (h.X   echo $user->getApiKey();h4}r\  (h6]h7]r]  Uotherr^  ah8]h9]h;]uh/jT  h)]r_  hGX   echo $user->getApiKey();r`  …ra  }rb  (h.U h/jZ  ubah2jÛ  ubaubeubh+)rc  }rd  (h.U h/h,h0h1h2h3h4}re  (h6]h7]h8]h9]rf  h(ah;]rg  hauh=K¡h>hh)]rh  (h@)ri  }rj  (h.X   Reset user API keyrk  h/jc  h0h1h2hDh4}rl  (h6]h7]h8]h9]h;]uh=K¡h>hh)]rm  hGX   Reset user API keyrn  …ro  }rp  (h.jk  h/ji  ubaubhY)rq  }rr  (h.XM   When resetting an API key, a new one will be automatically generated for
you:rs  h/jc  h0h1h2h]h4}rt  (h6]h7]h8]h9]h;]uh=K£h>hh)]ru  hGXM   When resetting an API key, a new one will be automatically generated for
you:rv  …rw  }rx  (h.js  h/jq  ubaubjÆ  )ry  }rz  (h.X.   $user->resetApiKey();
echo $user->getApiKey();h/jc  h0h1h2jÉ  h4}r{  (jË  jÌ  h9]h8]h6]h7]r|  (jÎ  X   phpr}  eh;]uh=Kªh>hh)]r~  jÑ  )r  }r€  (h.X.   $user->resetApiKey();
echo $user->getApiKey();h4}r  (h6]h7]r‚  Uotherrƒ  ah8]h9]h;]uh/jy  h)]r„  hGX.   $user->resetApiKey();
echo $user->getApiKey();r…  …r†  }r‡  (h.U h/j  ubah2jÛ  ubaubeubeubah.U Utransformerrˆ  NUfootnote_refsr‰  }rŠ  Urefnamesr‹  }rŒ  Usymbol_footnotesr  ]rŽ  Uautofootnote_refsr  ]r  Usymbol_footnote_refsr‘  ]r’  U	citationsr“  ]r”  h>hUcurrent_liner•  NUtransform_messagesr–  ]r—  Ureporterr˜  NUid_startr™  KUautofootnotesrš  ]r›  Ucitation_refsrœ  }r  Uindirect_targetsrž  ]rŸ  Usettingsr   (cdocutils.frontend
Values
r¡  or¢  }r£  (Ufootnote_backlinksr¤  KUrecord_dependenciesr¥  NUrfc_base_urlr¦  Uhttp://tools.ietf.org/html/r§  U	tracebackr¨  ˆUpep_referencesr©  NUstrip_commentsrª  NUtoc_backlinksr«  hÃUlanguage_coder¬  Uenr­  U	datestampr®  NUreport_levelr¯  KU_destinationr°  NU
halt_levelr±  KUstrip_classesr²  NhDNUerror_encoding_error_handlerr³  Ubackslashreplacer´  Udebugrµ  NUembed_stylesheetr¶  ‰Uoutput_encoding_error_handlerr·  Ustrictr¸  Usectnum_xformr¹  KUdump_transformsrº  NUdocinfo_xformr»  KUwarning_streamr¼  NUpep_file_url_templater½  Upep-%04dr¾  Uexit_status_levelr¿  KUconfigrÀ  NUstrict_visitorrÁ  NUcloak_email_addressesrÂ  ˆUtrim_footnote_reference_spacerÃ  ‰UenvrÄ  NUdump_pseudo_xmlrÅ  NUexpose_internalsrÆ  NUsectsubtitle_xformrÇ  ‰Usource_linkrÈ  NUrfc_referencesrÉ  NUoutput_encodingrÊ  Uutf-8rË  U
source_urlrÌ  NUinput_encodingrÍ  U	utf-8-sigrÎ  U_disable_configrÏ  NU	id_prefixrÐ  U U	tab_widthrÑ  KUerror_encodingrÒ  UUTF-8rÓ  U_sourcerÔ  h1Ugettext_compactrÕ  ˆU	generatorrÖ  NUdump_internalsr×  NUsmart_quotesrØ  ‰Upep_base_urlrÙ  Uhttp://www.python.org/dev/peps/rÚ  Usyntax_highlightrÛ  UlongrÜ  Uinput_encoding_error_handlerrÝ  j¸  Uauto_id_prefixrÞ  Uidrß  Udoctitle_xformrà  ‰Ustrip_elements_with_classesrá  NU_config_filesrâ  ]Ufile_insertion_enabledrã  ˆUraw_enabledrä  KUdump_settingsrå  NubUsymbol_footnote_startræ  K Uidsrç  }rè  (hj¸  h hchjF  h'j  h#hKh%j!  h"jß  h&jº  h$jì  h(jc  hj  h!h…hh,uUsubstitution_namesré  }rê  h2h>h4}rë  (h6]h9]h8]Usourceh1h7]h;]uU	footnotesrì  ]rí  Urefidsrî  }rï  ub.