Current File : /home/graphicd/www/vebto/vendor/rackspace/php-opencloud/doc/_build/doctrees/auth.doctree
�cdocutils.nodes
document
q)�q}q(U nametypesq}q(X authenticationqNX service catalogqNuUsubstitution_defsq}q Uparse_messagesq
]q Ucurrent_sourceq NU
decorationq
NUautofootnote_startqKUnameidsq}q(hUauthenticationqhUservice-catalogquUchildrenq]qcdocutils.nodes
section
q)�q}q(U rawsourceqU UparentqhUsourceqX- /Users/jamie/projects/php/v1-sdk/doc/auth.rstqUtagnameq Usectionq U
attributesq }q (Udupnamesq ]Uclassesq!]Ubackrefsq"]Uidsq#]q$haUnamesq%]q&hauUlineq'KUdocumentq(hh]q)(cdocutils.nodes
title
q*)�q+}q,(hX Authenticationq-hhhhh Utitleq.h }q/(h ]h!]h"]h#]h%]uh'Kh(hh]q0cdocutils.nodes
Text
q1X Authenticationq2��q3}q4(hh-hh+ubaubcdocutils.nodes
paragraph
q5)�q6}q7(hX� The client does not automatically authenticate against the API when it is
instantiated - it waits for an API call. When this happens, it checks
whether the current “token” has expired, and (re-)authenticates if
necessary.q8hhhhh U paragraphq9h }q:(h ]h!]h"]h#]h%]uh'Kh(hh]q;h1X� The client does not automatically authenticate against the API when it is
instantiated - it waits for an API call. When this happens, it checks
whether the current “token” has expired, and (re-)authenticates if
necessary.q<��q=}q>(hh8hh6ubaubh5)�q?}q@(hX) You can force authentication, by calling:qAhhhhh h9h }qB(h ]h!]h"]h#]h%]uh'K h(hh]qCh1X) You can force authentication, by calling:qD��qE}qF(hhAhh?ubaubcdocutils.nodes
literal_block
qG)�qH}qI(hX $client->authenticate();hhhhh U
literal_blockqJh }qK(UlinenosqL�UlanguageqMX phpU xml:spaceqNUpreserveqOh#]h"]h ]h!]h%]uh'K h(hh]qPh1X $client->authenticate();qQ��qR}qS(hU hhHubaubh5)�qT}qU(hX� If the credentials are incorrect, a ``401`` error will be returned. If
credentials are correct, a ``200`` status is returned with your Service
Catalog.hhhhh h9h }qV(h ]h!]h"]h#]h%]uh'Kh(hh]qW(h1X$ If the credentials are incorrect, a qX��qY}qZ(hX$ If the credentials are incorrect, a hhTubcdocutils.nodes
literal
q[)�q\}q](hX ``401``h }q^(h ]h!]h"]h#]h%]uhhTh]q_h1X 401q`��qa}qb(hU hh\ubah Uliteralqcubh1X7 error will be returned. If
credentials are correct, a qd��qe}qf(hX7 error will be returned. If
credentials are correct, a hhTubh[)�qg}qh(hX ``200``h }qi(h ]h!]h"]h#]h%]uhhTh]qjh1X 200qk��ql}qm(hU hhgubah hcubh1X. status is returned with your Service
Catalog.qn��qo}qp(hX. status is returned with your Service
Catalog.hhTubeubh)�qq}qr(hU hhhhh h h }qs(h ]h!]h"]h#]qthah%]quhauh'Kh(hh]qv(h*)�qw}qx(hX Service Catalogqyhhqhhh h.h }qz(h ]h!]h"]h#]h%]uh'Kh(hh]q{h1X Service Catalogq|��q}}q~(hhyhhwubaubh5)�q}q�(hX The Service Catalog is returned on successful authentication, and is
composed of all the different API services available to the current
tenant. All of this functionality is encapsulated in the ``Catalog``
object, which allows you greater control and interactivity.hhqhhh h9h }q�(h ]h!]h"]h#]h%]uh'Kh(hh]q�(h1X� The Service Catalog is returned on successful authentication, and is
composed of all the different API services available to the current
tenant. All of this functionality is encapsulated in the q���q�}q�(hX� The Service Catalog is returned on successful authentication, and is
composed of all the different API services available to the current
tenant. All of this functionality is encapsulated in the hhubh[)�q�}q�(hX ``Catalog``h }q�(h ]h!]h"]h#]h%]uhhh]q�h1X Catalogq���q�}q�(hU hh�ubah hcubh1X<
object, which allows you greater control and interactivity.q���q�}q�(hX<
object, which allows you greater control and interactivity.hhubeubhG)�q�}q�(hXc /** @var OpenCloud\Common\Service\Catalog */
$catalog = $client->getCatalog();
// Return a list of OpenCloud\Common\Service\CatalogItem objects
foreach ($catalog->getItems() as $catalogItem) {
$name = $catalogItem->getName();
$type = $catalogItem->getType();
if ($name == 'cloudServersOpenStack' && $type == 'compute') {
break;
}
// Array of OpenCloud\Common\Service\Endpoint objects
$endpoints = $catalogItem->getEndpoints();
foreach ($endpoints as $endpoint) {
if ($endpoint->getRegion() == 'DFW') {
echo $endpoint->getPublicUrl();
}
}
}hhqhhh hJh }q�(hL�hMX phphNhOh#]h"]h ]h!]h%]uh'K h(hh]q�h1Xc /** @var OpenCloud\Common\Service\Catalog */
$catalog = $client->getCatalog();
// Return a list of OpenCloud\Common\Service\CatalogItem objects
foreach ($catalog->getItems() as $catalogItem) {
$name = $catalogItem->getName();
$type = $catalogItem->getType();
if ($name == 'cloudServersOpenStack' && $type == 'compute') {
break;
}
// Array of OpenCloud\Common\Service\Endpoint objects
$endpoints = $catalogItem->getEndpoints();
foreach ($endpoints as $endpoint) {
if ($endpoint->getRegion() == 'DFW') {
echo $endpoint->getPublicUrl();
}
}
}q���q�}q�(hU hh�ubaubh5)�q�}q�(hX� As you can see, you have access to each Service’s name, type and list of
endpoints. Each endpoint provides access to the specific region, along
with its public and private endpoint URLs.q�hhqhhh h9h }q�(h ]h!]h"]h#]h%]uh'K4h(hh]q�h1X� As you can see, you have access to each Service’s name, type and list of
endpoints. Each endpoint provides access to the specific region, along
with its public and private endpoint URLs.q���q�}q�(hh�hh�ubaubeubeubahU U transformerq�NU
footnote_refsq�}q�Urefnamesq�}q�Usymbol_footnotesq�]q�Uautofootnote_refsq�]q�Usymbol_footnote_refsq�]q�U citationsq�]q�h(hU current_lineq�NUtransform_messagesq�]q�Ureporterq�NUid_startq�KU
autofootnotesq�]q�U
citation_refsq�}q�Uindirect_targetsq�]q�Usettingsq�(cdocutils.frontend
Values
q�oq�}q�(Ufootnote_backlinksq�KUrecord_dependenciesq�NU rfc_base_urlq�Uhttp://tools.ietf.org/html/q�U tracebackq��Upep_referencesq�NUstrip_commentsq�NU
toc_backlinksq�Uentryq�U
language_codeq�Uenq�U datestampq�NU report_levelq�KU _destinationq�NU
halt_levelq�KU
strip_classesq�Nh.NU error_encoding_error_handlerq�Ubackslashreplaceq�Udebugq�NUembed_stylesheetqΉU output_encoding_error_handlerq�Ustrictq�U
sectnum_xformq�KUdump_transformsq�NU
docinfo_xformq�KUwarning_streamq�NUpep_file_url_templateq�Upep-%04dq�Uexit_status_levelq�KUconfigq�NUstrict_visitorq�NUcloak_email_addressesqڈU trim_footnote_reference_spaceqۉUenvq�NUdump_pseudo_xmlq�NUexpose_internalsq�NUsectsubtitle_xformq߉U source_linkq�NUrfc_referencesq�NUoutput_encodingq�Uutf-8q�U
source_urlq�NUinput_encodingq�U utf-8-sigq�U_disable_configq�NU id_prefixq�U U tab_widthq�KUerror_encodingq�UUTF-8q�U_sourceq�hUgettext_compactq�U generatorq�NUdump_internalsq�NU smart_quotesq�U pep_base_urlq�U http://www.python.org/dev/peps/q�Usyntax_highlightq�Ulongq�U input_encoding_error_handlerq�h�Uauto_id_prefixq�Uidq�Udoctitle_xformq��Ustrip_elements_with_classesq�NU
_config_filesq�]Ufile_insertion_enabledq��U raw_enabledq�KU
dump_settingsq�NubUsymbol_footnote_startq�K Uidsq�}r (hhhhquUsubstitution_namesr }r h h(h }r (h ]h#]h"]Usourcehh!]h%]uU footnotesr ]r Urefidsr }r ub.
Mini Shell