diff options
| author | ya.wang <wang.ya@99cloud.net> | 2018-02-09 11:49:12 +0800 |
|---|---|---|
| committer | ya.wang <wang.ya@99cloud.net> | 2018-02-22 10:07:41 +0800 |
| commit | 9683a7e0c3cf56e76dc11312fa1458e5d96fe3b2 (patch) | |
| tree | d08f47ed576adfbf92f230c164345ae8a115a3cd /doc | |
| parent | 1da269b0e99601f8f6395b2ce3f436f5600e8140 (diff) | |
| download | python-ironicclient-9683a7e0c3cf56e76dc11312fa1458e5d96fe3b2.tar.gz | |
Update 'Usage' section in 'doc/source/api_v1.rst'
When I want to get the client with 'Using Identity Service (keystone)
credentials' section, it will throw errors.(usually http 400)
After testing it is found that two variables aare missing:
- os_user_domain_name
- os_project_domain_name
Now added them to the document.
Change-Id: Ibdebc7cf0fc017b7eeb378b022ce5cffcd943fb2
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api_v1.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/source/api_v1.rst b/doc/source/api_v1.rst index cd5c866..eb29c28 100644 --- a/doc/source/api_v1.rst +++ b/doc/source/api_v1.rst @@ -61,6 +61,13 @@ These Identity Service credentials can be used to authenticate:: service. default: False (optional) * os_tenant_{name|id}: name or ID of tenant +Also the following parameters are required when using the Identity API v3:: + + * os_user_domain_name: name of a domain the user belongs to, + usually 'default' + * os_project_domain_name: name of a domain the project belongs to, + usually 'default' + To create a client, you can use the API like so:: >>> from ironicclient import client |