Files
database-api/apidocs/target/docbkx/webhelp/cdb-devguide-reviewer/content/Authentication-d1e647.html
Nikhil Manchanda e434448adb Gerrit Review for Database Developer Guide
The Database Developer Guide PDF is located in the repo at:
apidocs/target/docbkx/webhelp/cdb-devguide-reviewer/cdb-devguide-reviewer.pdf

Updated api-doc with Security Groups related API information.

Added Security Groups and Security Group Rules as entities and related API calls to the Reddwarf API Docs.

Change-Id: I4d559b25413a6138cd7d2fb94c028f8cafde100c
2013-05-02 13:24:14 -05:00

56 lines
16 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:exsl="http://exslt.org/common" xmlns:ng="http://docbook.org/docbook-ng" xmlns:fb="http://ogp.me/ns/fb#"><head>
<title>3.1. Authentication - OpenStack Cloud Databases Developer Guide
 - API v1.0</title><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"/><meta name="mavenGroupId" content="com.rackspace.cloud.dbaas"/><meta name="mavenArtifactId" content="dbaas-docs"/><meta name="mavenVersionId" content="1.0.0-SNAPSHOT"/><link rel="home" href="index.html" title="OpenStack Cloud Databases Developer Guide"/><link rel="up" href="General_API_Information-d1e633.html" title="Chapter 3. General API Information"/><link rel="prev" href="General_API_Information-d1e633.html" title="Chapter 3. General API Information"/><link rel="next" href="DB_service_versions.html" title="3.2. Cloud Databases Service Versions"/><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><script type="text/javascript">
//The id for tree cookie
var treeCookieId = "treeview-5361";
var language = "en";
var w = new Object();
//Localization
txt_filesfound = 'Results';
txt_enter_at_least_1_char = "You must enter at least one character.";
txt_browser_not_supported = "Your browser is not supported. Use of Mozilla Firefox is recommended.";
txt_please_wait = "Please wait. Search in progress...";
txt_results_for = "Results for: ";
</script><style type="text/css">
input {
margin-bottom: 5px;
margin-top: 2px;
}
.folder {
display: block;
height: 22px;
padding-left: 20px;
background: transparent url(../common/jquery/treeview/images/folder.gif) 0 0px no-repeat;
}
</style><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"/><link rel="stylesheet" type="text/css" href="../common/css/positioning.css"/><link rel="stylesheet" type="text/css" href="../common/css/custom.css"/><link href="../atom.xml" type="application/atom+xml" rel="alternate" title="Document ATOM Feed"/><link rel="canonical" href="http://docs.rackspace.com/cdb/api/v1.0/cdb-devguide/content/Authentication-d1e647.html"/><!--[if IE]>
<link rel="stylesheet" type="text/css" href="../common/css/ie.css"/>
<![endif]--><link rel="stylesheet" type="text/css" href="../common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css"/><link rel="stylesheet" type="text/css" href="../common/jquery/treeview/jquery.treeview.css"/><script type="text/javascript" src="../common/jquery/jquery-1.4.3.min.js"><!----></script><script type="text/javascript" src="../common/jquery/jquery-ui-1.8.2.custom.min.js"><!----></script><script type="text/javascript" src="../common/jquery/jquery.cookie.js"><!----></script><script type="text/javascript" src="../common/jquery/treeview/jquery.treeview.min.js"><!----></script><script type="text/javascript" src="../common/jquery/jquery.qtip-1.0.0-rc3/jquery.qtip-1.0.0-rc3.min.js"><!--jQuery plugin for glossary popups. --></script><script type="text/javascript" src="search/htmlFileList.js"><!----></script><script type="text/javascript" src="search/htmlFileInfoList.js"><!----></script><script type="text/javascript" src="search/nwSearchFnt.js"><!----></script><script type="text/javascript" src="search/stemmers/en_stemmer.js"><!--//make this scalable to other languages as well.--></script><script type="text/javascript" src="search/index-1.js"><!----></script><script type="text/javascript" src="search/index-2.js"><!----></script><script type="text/javascript" src="search/index-3.js"><!----></script></head><body><div id="header"><a onclick="_gaq.push(['_trackEvent', 'Header', 'logo', 'click', 1]);" target="_blank" href="http://www.openstack.org"><img src="../common/images/openstack-logo.png" alt="OpenStack Documentation" width="157" height="47"/></a><h1>3.1. Authentication</h1><div id="navheader" align="right"><!----><table class="navLinks"><tr><td><a id="showHideButton" onclick="showHideToc(); _gaq.push(['_trackEvent', 'Header', 'show/hide', 'click', 1]);" class="pointLeft" title="Hide TOC tree">Sidebar
</a></td><td><a accesskey="p" class="navLinkPrevious" onclick="_gaq.push(['_trackEvent', 'Header', 'prevLink', 'click', 1]);" tabindex="5" href="General_API_Information-d1e633.html">Prev</a>
|
<a accesskey="u" class="navLinkUp" onclick="_gaq.push(['_trackEvent', 'Header', 'upLink', 'click', 1]);" tabindex="5" href="General_API_Information-d1e633.html">Up</a>
|
<a accesskey="n" class="navLinkNext" onclick="_gaq.push(['_trackEvent', 'Header', 'nextLink', 'click', 1]);" tabindex="5" href="DB_service_versions.html">Next</a></td></tr></table></div></div><div id="toolbar" class="ui-tabs-nav ui-helper-reset ui-helper-clearfix ui-widget-header ui-corner-all"><div id="toolbar-left"><p class="breadcrumbs"><a href="http://docs.openstack.org/">OpenStack Manuals</a><a href="index.html">OpenStack Cloud Databases Developer Guide
 - API v1.0</a></p><a onclick="_gaq.push(['_trackEvent', 'Header', 'pdfDownload', 'click', 1]);" alt="Download a pdf of this document" class="pdficon" href="../cdb-devguide-reviewer.pdf"><img src="../common/images/pdf.png"/></a>
 
<a href="../atom.xml"><img alt="Atom feed of this document" src="../common/images/feed-icon.png"/></a></div></div><div id="content"><div class="statustext">REVIEW -  REVIEW -  REVIEW -  REVIEW -  REVIEW -  REVIEW -  REVIEW -  REVIEW - </div><div class="section"><div xmlns="" class="titlepage"><div><div><h2 xmlns="http://www.w3.org/1999/xhtml" class="title" style="clear: both"><a id="Authentication-d1e647"> </a>3.1. Authentication</h2></div></div></div><p> Each HTTP request against the Cloud Database
service requires the inclusion of specific
authentication credentials. A single deployment may
support multiple authentication schemes (OAuth, Basic
Auth, Token). The authentication scheme used is
determined by the provider of the Cloud Database
service. Please contact your provider to determine the
best way to authenticate against this API.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../common/images/admon/note.png"/></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>Some authentication schemes may require that the
API operate using SSL over HTTP (HTTPS).</p></td></tr></table></div></div><script type="text/javascript" src="../common/main.js"><!----></script><hr/><div id="disqus_thread"><script type="text/javascript">
var disqus_shortname = 'openstackdocs';
var disqus_identifier = 'cdb-devguideAuthentication-d1e647';
</script><noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript><script type="text/javascript" src="../common/comments.js"><!----></script></div><hr/><div class="legal"><a href="index.html">Legal notices</a></div></div><div><div id="leftnavigation" style="padding-top:3px; background-color:white;"><div id="tabs"><ul><li><a href="#treeDiv" tabindex="1"><span class="contentsTab">Contents</span></a></li><li><a href="#searchDiv" tabindex="1"><span class="searchTab">Search</span></a></li></ul><div id="treeDiv"><img src="../common/images/loading.gif" alt="loading table of contents..." id="tocLoading" style="display:block;"/><div id="ulTreeDiv" style="display:none" class="thisisthat"><ul id="tree" class="filetree"><li tabindex="2"><span class="file"><a href="overview.html">1. Overview</a></span><ul><li tabindex="2"><span class="file"><a href="Intended_Audience-d1e122.html">1.1. Intended Audience</a></span></li><li tabindex="2"><span class="file"><a href="Document_Change_History-d1e166.html">1.2. Document Change History</a></span></li><li tabindex="2"><span class="file"><a href="Additional_Resources-d1e532.html">1.3. Additional Resources</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="Concepts-d1e563.html">2. Concepts</a></span><ul><li tabindex="2"><span class="file"><a href="Concepts-d1e563.html#DatabaseInstance-d1e588">2.1. Database Instance</a></span></li><li tabindex="2"><span class="file"><a href="Concepts-d1e563.html#Database">2.2. Database</a></span></li><li tabindex="2"><span class="file"><a href="Concepts-d1e563.html#Flavor">2.3. Flavor</a></span></li><li tabindex="2"><span class="file"><a href="Concepts-d1e563.html#Volume">2.4. Volume</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="General_API_Information-d1e633.html">3. General API Information</a></span><ul><li tabindex="2" id="webhelp-currentid"><span class="file"><a href="Authentication-d1e647.html">3.1. Authentication</a></span></li><li tabindex="2"><span class="file"><a href="DB_service_versions.html">3.2. Cloud Databases Service Versions</a></span><ul><li tabindex="2"><span class="file"><a href="Contract_Version-d1e825.html">3.2.1. Contract Version</a></span></li><li tabindex="2"><span class="file"><a href="API_Version_Headers-d1e855.html">3.2.2. API Version</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="datetimeformat.html">3.3. Date/Time Format</a></span></li><li tabindex="2"><span class="file"><a href="pagination.html">3.4. Pagination</a></span></li><li tabindex="2"><span class="file"><a href="DB_faults.html">3.5. Faults</a></span><ul><li tabindex="2"><span class="file"><a href="synchro_vs_async_faults.html">3.5.1. Synchronous Versus Asynchronous
Faults</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="database_instance_status.html">3.6. Database Instance Status</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="API_Operations-d1e2264.html">4. API Operations</a></span><ul><li tabindex="2"><span class="file"><a href="API_Versions.html">4.1. API Versions</a></span><ul><li tabindex="2"><span class="file"><a href="GET_getVersions__.html">4.1.1. List Versions</a></span></li><li tabindex="2"><span class="file"><a href="GET_getVersionInfo__version__.html">4.1.2. List Version Details</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="Database_Instances.html">4.2. Database Instances</a></span><ul><li tabindex="2"><span class="file"><a href="POST_createInstance__version___accountId__instances_.html">4.2.1. Create Database Instance</a></span></li><li tabindex="2"><span class="file"><a href="GET_getInstance__version___accountId__instances_.html">4.2.2. List All Database Instances</a></span></li><li tabindex="2"><span class="file"><a href="GET_getInstanceById__version___accountId__instances__instanceId__.html">4.2.3. List Database Instance Status and Details</a></span></li><li tabindex="2"><span class="file"><a href="DELETE_deleteInstance__version___accountId__instances__instanceId__.html">4.2.4. Delete Database Instance</a></span></li><li tabindex="2"><span class="file"><a href="POST_createRoot__version___accountId__instances__instanceId__root_.html">4.2.5. Enable Root User</a></span></li><li tabindex="2"><span class="file"><a href="GET_isRootEnabled__version___accountId__instances__instanceId__root_.html">4.2.6. List Root-Enabled Status</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="Database_Instances_Actions.html">4.3. Database Instance Actions</a></span><ul><li tabindex="2"><span class="file"><a href="POST_restartInstance__version___accountId__instances__instanceId__action_.html">4.3.1. Restart Instance</a></span></li><li tabindex="2"><span class="file"><a href="POST_resizeInstance__version___accountId__instances__instanceId__action_.html">4.3.2. Resize the Instance</a></span></li><li tabindex="2"><span class="file"><a href="POST_resizeVolume__version___accountId__instances__instanceId__action_.html">4.3.3. Resize the Instance Volume</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="databases.html">4.4. Databases</a></span><ul><li tabindex="2"><span class="file"><a href="POST_createDatabase__version___accountId__instances__instanceId__databases_.html">4.4.1. Create Database</a></span></li><li tabindex="2"><span class="file"><a href="GET_getDatabases__version___accountId__instances__instanceId__databases_.html">4.4.2. List Databases for Instance</a></span></li><li tabindex="2"><span class="file"><a href="DELETE_deleteDatabase__version___accountId__instances__instanceId__databases__databaseName__.html">4.4.3. Delete Database</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="user_management.html">4.5. Users</a></span><ul><li tabindex="2"><span class="file"><a href="POST_createUser__version___accountId__instances__instanceId__users_.html">4.5.1. Create User</a></span></li><li tabindex="2"><span class="file"><a href="GET_getUsers__version___accountId__instances__instanceId__users_.html">4.5.2. List Users in Database Instance</a></span></li><li tabindex="2"><span class="file"><a href="PUT_changePass__version___accountId__instances__instanceId__users_.html">4.5.3. Change User(s) Password</a></span></li><li tabindex="2"><span class="file"><a href="GET_listUser__version___accountId__instances__instanceId__users__name__.html">4.5.4. List User</a></span></li><li tabindex="2"><span class="file"><a href="DELETE_deleteUser__version___accountId__instances__instanceId__users__name__.html">4.5.5. Delete User</a></span></li><li tabindex="2"><span class="file"><a href="GET_getUserAccess__version___accountId__instances__instanceId__users__name__databases_.html">4.5.6. List User Access</a></span></li><li tabindex="2"><span class="file"><a href="PUT_grantUserAccess__version___accountId__instances__instanceId__users__name__databases_.html">4.5.7. Grant User Access</a></span></li><li tabindex="2"><span class="file"><a href="DELETE_revokeUserAccess__version___accountId__instances__instanceId__users__name__databases__databaseName__.html">4.5.8. Revoke User Access</a></span></li></ul></li><li tabindex="2"><span class="file"><a href="flavors.html">4.6. Flavors</a></span><ul><li tabindex="2"><span class="file"><a href="GET_getFlavors__version___accountId__flavors_.html">4.6.1. List Flavors</a></span></li><li tabindex="2"><span class="file"><a href="GET_getFlavorById__version___accountId__flavors__flavorId__.html">4.6.2. List Flavor By ID</a></span></li></ul></li></ul></li><li tabindex="2"><span class="file"><a href="go01.html">Glossary</a></span></li></ul></div></div><div id="searchDiv"><div id="search"><form onsubmit="Verifie(ditaSearch_Form);return false" name="ditaSearch_Form" class="searchForm"><fieldset class="searchFieldSet"><legend>Search</legend><center><input id="textToSearch" name="textToSearch" type="text" class="searchText"/> &nbsp; <input onclick="Verifie(ditaSearch_Form)" type="button" class="searchButton" value="Go" id="doSearch"/></center></fieldset></form></div><div id="searchResults"><center/></div><p class="searchHighlight"><a href="#" onclick="toggleHighlight()">Search Highlighter (On/Off)</a></p></div></div></div></div><script type="text/javascript" src="../common/jquery/jquery.qtip-1.0.0-rc3/jquery.qtip-1.0.0-rc3.min.js"><!--jQuery plugin for glossary popups. -->
$('a[title]').qtip({ style: { name: 'cream', tip: true } })
</script></body></html>