@itentialopensource/adapter-openstack_keystone
Version:
This adapter integrates with system described as: Openstack Keystone.
1,076 lines (1,008 loc) • 3.13 MB
HTML
<!DOCTYPE html>
<!-- saved from url=(0047)https://docs.openstack.org/api-ref/identity/v3/ -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/">
<title>Identity API v3 (CURRENT) — keystone documentation</title>
<link rel="stylesheet" type="text/css" href="./Identity API v3 (CURRENT) — keystone documentation_files/pygments.css">
<link rel="stylesheet" type="text/css" href="./Identity API v3 (CURRENT) — keystone documentation_files/basic.css">
<link rel="stylesheet" type="text/css" href="./Identity API v3 (CURRENT) — keystone documentation_files/api-site.css">
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/embed.min.js.pobierz"></script>
<script async="" src="./Identity API v3 (CURRENT) — keystone documentation_files/analytics.js.pobierz"></script>
<script data-url_root="../" id="documentation_options"
src="./Identity API v3 (CURRENT) — keystone documentation_files/documentation_options.js.pobierz"></script>
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/jquery.js.pobierz"></script>
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/underscore.js.pobierz"></script>
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/doctools.js.pobierz"></script>
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/api-site.js.pobierz"></script>
<script src="./Identity API v3 (CURRENT) — keystone documentation_files/combobox.js.pobierz"></script>
<link rel="index" title="Index" href="https://docs.openstack.org/api-ref/identity/genindex.html">
<link rel="search" title="Search" href="https://docs.openstack.org/api-ref/identity/search.html">
<link rel="next" title="Identity API v3 extensions (CURRENT)"
href="https://docs.openstack.org/api-ref/identity/v3-ext/index.html">
<link rel="prev" title="Identity API v2.0 extensions (DEPRECATED)"
href="https://docs.openstack.org/api-ref/identity/v2-ext/index.html">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Bootstrap CSS -->
<link href="./Identity API v3 (CURRENT) — keystone documentation_files/bootstrap.min.css" rel="stylesheet">
<!-- Fonts -->
<link href="./Identity API v3 (CURRENT) — keystone documentation_files/font-awesome.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="./Identity API v3 (CURRENT) — keystone documentation_files/combined.css" rel="stylesheet">
<!-- Search CSS -->
<link href="./Identity API v3 (CURRENT) — keystone documentation_files/search.css" rel="stylesheet">
<!-- Pygments CSS -->
<link href="./Identity API v3 (CURRENT) — keystone documentation_files/pygments.css" rel="stylesheet">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Google Analytics -->
<script>
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-17511903-1', 'auto');
ga('send', 'pageview');
</script>
<!-- End Google Analytics -->
<style type="text/css">
.ossw-search-bar-wrapper {
position: relative;
}
#search-bar-input {
width: 100%;
border: 2px solid #dae5ee;
border-radius: 4px;
height: 37px;
padding: 0 0 0 10px;
background: #fff;
color: #30739C;
font-size: 12px;
text-transform: lowercase;
font-weight: 400;
}
#search-bar-input::placeholder {
color: #C7CAE0;
}
#search-bar-input:focus {
border-color: #30739C;
outline: none;
}
.ossw-search-bar-close {
cursor: pointer;
position: absolute;
top: 10px;
right: 15px;
color: #dae5ee;
z-index: 1001;
font-size: 16px;
}
.ossw-search-bar-close:hover {
color: #30739C;
}
.ossw-no-results {
font-size: 12px;
font-weight: 500;
line-height: 1;
color: #8B9BAD;
}
.ossw-search-suggestions-wrapper {
display: none;
}
.ossw-search-suggestions {
border: 1px solid #DDDDDD;
padding: 5px;
position: relative;
top: 10px;
z-index: 9999;
background: white;
width: 100%;
}
.ossw-result-item {
padding: 10px 5px;
display: block;
position: relative;
cursor: pointer;
border-bottom: 1px solid #E9EDF2;
text-align: left;
text-decoration: none
}
.ossw-result-item:before {
right: 22px;
top: 50%;
margin-top: -3px;
width: 6px;
height: 6px;
border-style: solid;
border-width: 1px 1px 0 0;
border-color: #C5D1DE;
-webkit-transform: rotate(45deg);
-moz-transform: rotate(45deg);
-ms-transform: rotate(45deg);
transform: rotate(45deg);
display: block;
position: absolute;
content: ""
}
.ossw-result-item:after {
display: table;
content: "";
width: 0;
height: 0;
clear: both
}
.ossw-result-item:hover {
background-color: rgba(0, 0, 0, 0.05);
}
.ossw-result-item:hover:before {
border-color: #8B9BAD
}
.ossw-result-item:hover .ossw-result-detail {
color: #3B454F
}
.ossw-result-item em {
font-style: normal;
-webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1);
-moz-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1);
box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1);
font-weight: bold;
background-color: #f6fcfe;
}
.ossw-result-heading {
width: 90%;
font-weight: 500;
font-size: 13px;
line-height: 1.2;
margin-bottom: 4px;
color: #258BF8;
white-space: nowrap;
overflow: hidden;
-ms-text-overflow: ellipsis;
text-overflow: ellipsis;
}
.ossw-result-detail {
width: 90%;
max-height: 31px;
overflow: hidden;
font-size: 12px;
font-weight: 400;
line-height: 1.4;
color: #8B9BAD
}
.ossw-search-results {
display: none;
}
.ossw-search-results .ossw-overlay {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: rgba(0, 0, 0, 0.5);
z-index: 99999991
}
.ossw-search-results .ossw-overlay.ossw-dismiss {
display: none
}
.ossw-search-results .ossw-overlay.ossw-dismiss .ossw-container {
opacity: 0;
-webkit-animation: st-ui-fade-out ease-in-out 0.5s;
-moz-animation: st-ui-fade-out ease-in-out 0.5s;
animation: st-ui-fade-out ease-in-out 0.5s
}
.ossw-search-results .ossw-container {
position: fixed;
top: 0;
margin: 64px 0 0 0;
width: 60%;
height: 80%;
max-width: 800px;
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
background: #fff;
z-index: 99999992;
-webkit-animation: st-ui-fade-in ease-in-out 0.5s;
-moz-animation: st-ui-fade-in ease-in-out 0.5s;
animation: st-ui-fade-in ease-in-out 0.5s;
overflow: hidden;
-webkit-text-size-adjust: none;
-ms-text-size-adjust: none;
text-size-adjust: none;
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif;
}
@media (max-width: 660px) {
.ossw-pagination .ossw-page-link:not(.ossw-active):not(.next) {
display: none !important;
}
}
@media only screen and (orientation: portrait) {
.ossw-search-results .ossw-container {
height: 60%;
}
}
.ossw-search-results .ossw-container .ossw-header-wrapper {
margin: 0;
padding: 0;
border: 0;
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
-webkit-font-smoothing: antialiased;
-webkit-text-size-adjust: none;
-ms-text-size-adjust: none;
text-size-adjust: none;
font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header {
position: relative;
width: 100%;
height: 49px;
border-bottom: 1px solid rgba(0, 0, 0, 0.1);
z-index: 99999997;
background: #F9FAFB;
-moz-background-clip: padding-box;
background-clip: padding-box;
-webkit-backface-visibility: hidden;
-moz-backface-visibility: hidden;
backface-visibility: hidden;
-webkit-border-radius: 5px 5px 0 0;
-moz-border-radius: 5px 5px 0 0;
border-radius: 5px 5px 0 0;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header input {
padding: 0 120px 0 36px;
width: 100%;
height: 48px;
background: transparent;
border: 0;
outline: none;
color: #3B454F;
font-size: 15px;
font-weight: 500;
line-height: 19px;
-webkit-border-radius: 5px 5px 0 0;
-moz-border-radius: 5px 5px 0 0;
border-radius: 5px 5px 0 0;
font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header input:focus {
height: 50px;
border-bottom: 2px solid #33AAFF
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-search-icon {
display: block;
position: absolute;
top: 18px;
left: 15px;
width: 13px;
height: 13px;
pointer-events: none;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-search-icon .fa {
opacity: 0.6;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon {
display: block;
position: absolute;
top: 16px;
right: 14px;
width: 16px;
height: 16px;
cursor: pointer;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon .fa {
opacity: 0.6;
}
.ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon .fa:hover {
opacity: 1;
}
.ossw-search-results .ossw-suggestions-wrapper {
position: absolute;
top: 0;
left: 0;
margin: 0;
padding: 68px 10px;
width: 50%;
height: 100%;
z-index: 99999995;
background: #fff;
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
border: 0;
-webkit-animation: st-ui-slide-in ease-in-out 0.5s;
-moz-animation: st-ui-slide-in ease-in-out 0.5s;
animation: st-ui-slide-in ease-in-out 0.5s;
-webkit-box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2);
-moz-box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2);
box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2);
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
}
.ossw-search-results .ossw-suggestions-wrapper .ossw-heading {
margin-bottom: 0;
padding: 6px 18px 14px 0;
border-bottom: 1px solid #E9EDF2;
color: rgba(0, 0, 0, 0.4);
}
.ossw-search-results .ossw-results-wrapper {
position: absolute;
top: 0;
left: 0;
padding: 50px 0px;
width: 100%;
height: 100%;
overflow: auto;
-webkit-overflow-scrolling: touch;
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
border-radius: 5px;
}
.ossw-search-results .ossw-results-wrapper .ossw-results {
padding: 0 10px 50px 10px;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer {
position: absolute;
bottom: 0;
left: 0;
width: 100%;
height: 49px;
border-top: 1px solid rgba(0, 0, 0, 0.1);
background: #F9FAFB;
z-index: 99999996;
-moz-background-clip: padding-box;
background-clip: padding-box;
-webkit-backface-visibility: hidden;
-moz-backface-visibility: hidden;
backface-visibility: hidden;
-webkit-border-radius: 0 0 5px 5px;
-moz-border-radius: 0 0 5px 5px;
border-radius: 0 0 5px 5px;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-summary {
display: block;
position: absolute;
width: 65%;
top: 18px;
left: 16px;
float: left;
font-size: 12px;
font-weight: 500;
line-height: 1;
color: #8B9BAD;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination {
display: block;
padding-right: 9px;
float: right;
text-align: right;
font-size: 12px;
font-weight: 500;
color: #8B9BAD;
line-height: 1;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link {
display: inline-block;
padding: 18px 7px;
text-decoration: none;
color: #258BF8;
text-transform: uppercase;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link.ossw-active {
color: #8B9BAD;
}
.ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link .ossw-right-arrow {
display: inline-block;
position: relative;
width: 6px;
height: 6px;
margin: 0 0 0 2px;
}
</style>
</head>
<body>
<!-- SOURCE_FILE: https://opendev.org/openstack/keystone/src/api-ref/source/v3/index.rst -->
<script>
(function (window, document) {
var loader = function () {
var script = document.createElement("script"), tag = document.getElementsByTagName("script")[0];
script.src = "https://search.openstack.org/widget/embed.min.js?t=" + Date.now();
tag.parentNode.insertBefore(script, tag);
};
window.addEventListener ? window.addEventListener("load", loader, false) : window.attachEvent("onload", loader);
})(window, document);
</script>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="brand-wrapper">
<a class="navbar-brand" href="https://www.openstack.org/"></a>
</div>
<div class="search-icon show"><i class="fa fa-search"></i> Search</div>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<div class="search-container tiny">
<div class="openstack-search-bar" data-baseurl="search.openstack.org" data-context="docs-openstack">
<div class="ossw-search-wrapper">
<div class="ossw-search-bar-wrapper"><input type="text" id="search-bar-input"
placeholder="Search OpenStack" value=""> <i class="fa fa-times ossw-search-bar-close"></i></div>
<div class="ossw-search-suggestions-wrapper"></div>
<div class="ossw-search-results">
<div class="ossw-overlay"></div>
<div class="ossw-container">
<div class="ossw-header-wrapper">
<section class="ossw-header"><input type="text" placeholder="Search OpenStack"
id="search-popup-input" value=""> <span class="ossw-search-icon"><i
class="fa fa-search"></i></span> <a class="ossw-close-icon"><i class="fa fa-times"></i></a>
</section>
</div>
<div>
<section style="display: none;" class="ossw-suggestions-wrapper">
<div class="ossw-heading">suggested results</div>
<div class="ossw-suggestions"></div>
</section>
<section class="ossw-results-wrapper">
<div style="display: block;" class="ossw-results"></div>
</section>
</div>
<div class="ossw-footer-wrapper">
<section class="ossw-footer"><span class="ossw-summary">
<div>No results found for “”</div>
</span></section>
</div>
</div>
</div>
</div>
</div>
</div>
<ul class="nav navbar-nav navbar-main show">
<li class="search-container-mobile">
<div class="openstack-search-bar" data-baseurl="search.openstack.org" data-context="docs-openstack">
<div class="ossw-search-wrapper">
<div class="ossw-search-bar-wrapper"><input type="text" id="search-bar-input"
placeholder="Search OpenStack" value=""> <i class="fa fa-times ossw-search-bar-close"></i></div>
<div class="ossw-search-suggestions-wrapper"></div>
<div class="ossw-search-results">
<div class="ossw-overlay"></div>
<div class="ossw-container">
<div class="ossw-header-wrapper">
<section class="ossw-header"><input type="text" placeholder="Search OpenStack"
id="search-popup-input" value=""> <span class="ossw-search-icon"><i
class="fa fa-search"></i></span> <a class="ossw-close-icon"><i class="fa fa-times"></i></a>
</section>
</div>
<div>
<section style="display: none;" class="ossw-suggestions-wrapper">
<div class="ossw-heading">suggested results</div>
<div class="ossw-suggestions"></div>
</section>
<section class="ossw-results-wrapper">
<div style="display: block;" class="ossw-results"></div>
</section>
</div>
<div class="ossw-footer-wrapper">
<section class="ossw-footer"><span class="ossw-summary">
<div>No results found for “”</div>
</span></section>
</div>
</div>
</div>
</div>
</div>
</li>
<li>
<!--Software -->
<a href="https://www.openstack.org/software/" class="drop" id="dropdownMenuSoftware">Software <i
class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuSoftware">
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/software/">Overview</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/software/project-navigator/openstack-components">OpenStack
Components</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/software/project-navigator/sdks">SDKs</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/software/project-navigator/deployment-tools">Deployment Tools</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/assets/software/projectmap/openstack-map.pdf"
target="_blank">OpenStack Map</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/software/sample-configs/">Sample Configs</a></li>
</ul>
</li>
<li>
<!-- Use Cases -->
<a href="https://www.openstack.org/use-cases/" class="drop" id="dropdownMenuUsers">Use Cases <i
class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuUsers">
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/">Users
in Production</a></li>
<li role="presentation" class="divider"></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/bare-metal/">Ironic Bare Metal</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/edge-computing/">Edge Computing</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/telecoms-and-nfv/">Telecom & NFV</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/science/">Science and HPC</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/containers/">Containers</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/use-cases/enterprise/">Enterprise</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/surveys/landing">User Survey</a></li>
</ul>
</li>
<li>
<!-- Events -->
<a href="https://www.openstack.org/events/" class="drop" id="dropdownMenuEvents">Events <i
class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents">
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/summit/">Open
Infrastructure Summits</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/ptg/">Project
Teams Gathering</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/events/opendev-2020/">OpenDev</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/events/community-events/">Community Events</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/events/openstackdays">OpenStack & OpenInfra Days</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/videos/">Summit
Videos</a></li>
</ul>
</li>
<li>
<!-- Community -->
<a href="https://www.openstack.org/community/" class="drop" id="dropdownMenuCommunity">Community <i
class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuCommunity">
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/">Welcome! Start Here</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/tech-committee">OpenStack Technical Committee</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/speakers/">Speakers Bureau</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://wiki.openstack.org/">OpenStack
Wiki</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/coa/">Get
Certified (COA)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/jobs/">Jobs</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketing/">Marketing Resources</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/news/">Community
News</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://superuser.openstack.org/">Superuser
Magazine</a></li>
<li role="presentation" class="divider"></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/community/supporting-organizations/">OpenInfra Foundation Supporting
Organizations</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/">Open Infrastructure
Foundation (OpenInfra Foundation)</a></li>
</ul>
</li>
<li>
<!-- Marketplace -->
<a href="https://www.openstack.orgmarketplace/" class="drop" id="dropdownMenuLearn">Marketplace <i
class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents">
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/training/">Training</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/distros/">Distros & Appliances</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/public-clouds/">Public Clouds</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/hosted-private-clouds/">Hosted Private Clouds</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/remotely-managed-private-clouds/">Remotely Managed Private
Clouds</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/consulting/">Consulting & Integrators</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1"
href="https://www.openstack.org/marketplace/drivers/">Drivers</a></li>
</ul>
</li>
<li>
<!-- Blog -->
<a href="https://www.openstack.org/blog/">Blog</a>
</li>
<li>
<!-- Docs -->
<a href="http://docs.openstack.org/">Docs</a>
</li>
<li>
<!-- Join -->
</li>
<li class="join-nav-section">
<a href="https://openinfra.dev/join/" id="dropdownMenuJoin">Join <i class="fa fa-caret-down"></i></a>
<ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuJoin"
style="display: none;">
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sign up for
Foundation Membership</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sponsor the
Foundation</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/">More about the
Foundation</a></li>
</ul>
</li>
<li>
<a href="https://www.openstack.org/Security/login/?BackURL=/home/" class="sign-in-btn">Log In</a>
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<div class="container docs-book-wrapper">
<div class="row">
<div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4">
<div class="row docs-title">
<div class="col-lg-8">
<h1>OpenStack API Documentation</h1>
</div>
<div class="docs-actions">
<a href="https://docs.openstack.org/api-ref/identity/v2-ext/index.html"><i class="fa fa-angle-double-left"
data-toggle="tooltip" data-placement="top" title=""
data-original-title="Previous: Identity API v2.0 extensions (DEPRECATED)"></i></a>
<a href="https://docs.openstack.org/api-ref/identity/v3-ext/index.html"><i class="fa fa-angle-double-right"
data-toggle="tooltip" data-placement="top" title=""
data-original-title="Next: Identity API v3 extensions (CURRENT)"></i></a>
<a id="logABugLink1"
href="https://bugs.launchpad.net/keystone/+filebug?field.title=Identity%20API%20v3%20(CURRENT)%20in%20keystone&field.tags=api-ref&field.comment=%0A%0A%0AThis%20bug%20tracker%20is%20for%20errors%20with%20the%20documentation,%20use%20the%20following%20as%20a%20template%20and%20remove%20or%20add%20fields%20as%20you%20see%20fit.%20Convert%20[%20]%20into%20[x]%20to%20check%20boxes:%0A%0A-%20[%20]%20This%20doc%20is%20inaccurate%20in%20this%20way:%20______%0A-%20[%20]%20This%20is%20a%20doc%20addition%20request.%0A-%20[%20]%20I%20have%20a%20fix%20to%20the%20document%20that%20I%20can%20paste%20below%20including%20example:%20input%20and%20output.%20%0A%0AIf%20you%20have%20a%20troubleshooting%20or%20support%20issue,%20use%20the%20following%20%20resources:%0A%0A%20-%20The%20mailing%20list:%20https://lists.openstack.org%0A%20-%20IRC:%20%27openstack%27%20channel%20on%20OFTC%0A%0A-----------------------------------%0ARelease:%20%20on%202022-06-24%2015:22:49%0ASHA:%207c2d0f589c8daf5c65a80ed20d1e7fbfcc282312%0ASource:%20https://opendev.org/openstack/keystone/src/api-ref/source/v3/index.rst%0AURL:%20https://docs.openstack.org/api-ref/identity/v3/"
target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug"
data-toggle="tooltip" data-placement="top" title="" data-original-title="Report a Bug"></i></a>
</div>
</div>
<div class="row">
<div class="col-lg-12">
<div class="docs-body" role="main">
<section id="identity-api-v3-current">
<h1>Identity API v3 (CURRENT)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#identity-api-v3-current"
title="Permalink to this headline">¶</a></h1>
<p>The Identity service generates authentication tokens that permit access to the
OpenStack services REST APIs. Clients obtain this token and the URL endpoints
for other service APIs by supplying their valid credentials to the
authentication service.</p>
<p>Each time you make a REST API request to an OpenStack service, you supply your
authentication token in the X-Auth-Token request header.</p>
<p>Like most OpenStack projects, OpenStack Identity protects its APIs by defining
policy rules based on a role-based access control (RBAC) approach.</p>
<p>The Identity service configuration file sets the name and location of a JSON
policy file that stores these rules.</p>
<p>Note that the V3 API implements HEAD for all GET requests. Each HEAD request
contains the same headers and HTTP status code as the corresponding GET API.</p>
<p>For information about Identity API protection, see
<a class="reference external"
href="https://docs.openstack.org/keystone/latest/admin/service-api-protection.html">Identity API
protection with role-based access control (RBAC)</a>
in the OpenStack Cloud Administrator Guide.
</p>
<section id="what-s-new-in-version-3-14-ussuri">
<h2>What’s New in Version 3.14 (Ussuri)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-14-ussuri"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>New attribute <code
class="docutils literal notranslate"><span class="pre">authorization_ttl</span></code> for
identity providers</p>
</li>
<li>
<p>New attribute <code
class="docutils literal notranslate"><span class="pre">membership_expires_at</span></code>
when listing groups for a user</p>
</li>
<li>
<p>Ability to persist group memberships carried through mapping for a federated user</p>
</li>
<li>
<p>Added the ability to create, update and delete federated attributes for a user</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-13-train">
<h2>What’s New in Version 3.13 (Train)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-13-train"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>New parameter access_rules for application credentials</p>
</li>
<li>
<p>New read-only API /v3/users/{user_id}/access_rules for viewing access rules</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-12-stein">
<h2>What’s New in Version 3.12 (Stein)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-12-stein"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>New optional multi-factor auth process involving auth receipts</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-11-rocky">
<h2>What’s New in Version 3.11 (Rocky)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-11-rocky"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>New endpoint /v3/limits-model for discovering the limit model in effect</p>
</li>
<li>
<p>New description field in registered and project limits</p>
</li>
<li>
<p>New project_id filters for project limits</p>
</li>
<li>
<p>New parameter include_limits for project detail query</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-10-queens">
<h2>What’s New in Version 3.10 (Queens)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-10-queens"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Introduction of the Application Credentials API.</p>
</li>
<li>
<p>Introduction of an experimental Unified Limits API.</p>
</li>
<li>
<p>Ability to grant system role assignments and obtain system-scoped tokens.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-9-queens">
<h2>What’s New in Version 3.9 (Queens)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-9-queens"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Addition of <code class="docutils literal notranslate"><span class="pre">tags</span></code>
attribute to project.</p>
</li>
<li>
<p>New APIs to interact with the <code
class="docutils literal notranslate"><span class="pre">tags</span></code> attribute.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-8-ocata">
<h2>What’s New in Version 3.8 (Ocata)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-8-ocata"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Allow a service user to fetch a token that has expired.</p>
</li>
<li>
<p>Add a <code
class="docutils literal notranslate"><span class="pre">password_expires_at</span></code> query
parameter to user list and users in
group list.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-7-newton">
<h2>What’s New in Version 3.7 (Newton)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-7-newton"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Addition of the <code
class="docutils literal notranslate"><span class="pre">password_expires_at</span></code> field
to the user response object.</p>
</li>
<li>
<p>Introduce a flag to bypass expiration and revocation checking.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-6-mitaka">
<h2>What’s New in Version 3.6 (Mitaka)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-6-mitaka"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Listing role assignments for a tree of projects.</p>
</li>
<li>
<p>Setting the project <code
class="docutils literal notranslate"><span class="pre">is_domain</span></code> attribute
enables a project to behave as
a domain.</p>
</li>
<li>
<p>Addition of the <code
class="docutils literal notranslate"><span class="pre">is_domain</span></code> field to
project scoped token response that
represents whether a project is acting as a domain.</p>
</li>
<li>
<p>Enable or disable a subtree in the project hierarchy.</p>
</li>
<li>
<p>Delete a subtree in the project hierarchy.</p>
</li>
<li>
<p>Additional identifier for tokens scoped to the designated <code
class="docutils literal notranslate"><span class="pre">admin</span> <span class="pre">project</span></code>.
</p>
</li>
<li>
<p>Addition of <code
class="docutils literal notranslate"><span class="pre">domain_id</span></code> filter to list
user projects</p>
</li>
<li>
<p>One role can imply another via role_inference rules.</p>
</li>
<li>
<p>Enhance list role assignment to optionally provide names of entities.</p>
</li>
<li>
<p>The defaults for domain-specific configuration options can be retrieved.</p>
</li>
<li>
<p>Assignments can be specified as inherited, causing the assignment to be
placed on any sub-projects.</p>
</li>
<li>
<p>Support for domain specific roles.</p>
</li>
<li>
<p>Support <code class="docutils literal notranslate"><span class="pre">enabled</span></code> and
<code class="docutils literal notranslate"><span class="pre">id</span></code> as optional
attributes to filter identity
providers when listing.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-5-liberty">
<h2>What’s New in Version 3.5 (Liberty)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-5-liberty"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>Addition of <code class="docutils literal notranslate"><span class="pre">type</span></code>
optional attribute to list credentials.</p>
</li>
<li>
<p>Addition of <code
class="docutils literal notranslate"><span class="pre">region_id</span></code> optional
attribute to list endpoints.</p>
</li>
<li>
<p>Addition of <code
class="docutils literal notranslate"><span class="pre">is_domain</span></code> optional
attribute to projects. Setting this
currently has no effect, it is reserved for future use.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-4-kilo">
<h2>What’s New in Version 3.4 (Kilo)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-4-kilo"
title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>
<p>For tokenless authorization, the scope information may be set in the
request headers.</p>
</li>
<li>
<p>Addition of <code
class="docutils literal notranslate"><span class="pre">parent_id</span></code> optional
attribute to projects. This enables the
construction of a hierarchy of projects.</p>
</li>
<li>
<p>Addition of domain specific configuration management for a domain entity.</p>
</li>
<li>
<p>Removal of <code class="docutils literal notranslate"><span class="pre">url</span></code>
optional attribute for <code
class="docutils literal notranslate"><span class="pre">regions</span></code>. This attribute
was
only used for the experimental phase of keystone-to-keystone federation and
has been superseded by making service provider entries have its own entry in
the service catalog.</p>
</li>
<li>
<p>The JSON Home support now will indicate the status of resource if it is not
stable and current.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-3-juno">
<h2>What’s New in Version 3.3 (Juno)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-3-juno"
title="Permalink to this headline">¶</a></h2>
<p>These features are considered stable as of September 4th, 2014.</p>
<ul class="simple">
<li>
<p>Addition of <code class="docutils literal notranslate"><span class="pre">name</span></code>
optional variable to be included from service definition
into the service catalog.</p>
</li>
<li>
<p>Introduced a stand alone call to retrieve a service catalog.</p>
</li>
<li>
<p>Introduced support for JSON Home.</p>
</li>
<li>
<p>Introduced a standard call to retrieve possible project and domain scope
targets for a token.</p>
</li>
<li>
<p>Addition of <code class="docutils literal notranslate"><span class="pre">url</span></code>
optional attribute for <code
class="docutils literal notranslate"><span class="pre">regions</span></code>.</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-2-icehouse">
<h2>What’s New in Version 3.2 (Icehouse)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-2-icehouse"
title="Permalink to this headline">¶</a></h2>
<p>These features are considered stable as of January 23, 2014.</p>
<ul class="simple">
<li>
<p>Introduced a mechanism to opt-out from catalog information during
token validation</p>
</li>
<li>
<p>Introduced a region resource for constructing a hierarchical
container of groups of service endpoints</p>
</li>
<li>
<p>Inexact filtering is supported on string attributes</p>
</li>
<li>
<p>Listing collections may indicate only a subset of the data has been
provided if a particular deployment has limited the number of entries
a query may return</p>
</li>
</ul>
</section>
<section id="what-s-new-in-version-3-1-havana">
<h2>What’s New in Version 3.1 (Havana)<a class="headerlink"
href="https://docs.openstack.org/api-ref/identity/v3/#what-s-new-in-version-3-1-havana"
title="Permalink to this headline">¶</a></h2>
<p>These features are considered stable as of July 18, 2013.</p>
<ul class="simple">
<li>
<p>A token without an explicit scope of authorization is issued if the user does
not specify a proj