Nova/UserManagerAPISpec - Revision history

Ryan Lane: Text replace - "NovaSpec" to "NovaSpec"

2013-02-17T23:31:08Z

Text replace - "NovaSpec" to "NovaSpec"

Ryan Lane: Text replace - "NOTOC" to ""

2013-02-17T23:30:10Z

Text replace - "__NOTOC__" to ""

SorenHansen at 18:53, 28 October 2010

2010-10-28T18:53:57Z

SorenHansen at 18:04, 28 October 2010

2010-10-28T18:04:16Z

SorenHansen at 18:03, 28 October 2010

2010-10-28T18:03:23Z

New page

__NOTOC__
* '''Launchpad Entry''': [[NovaSpec]]:auth-manager-api
* '''Created''': 2010-10-28
* '''Contributors''': Soren Hansen

= Summary =

Expose a user management API.

= Release Note =

[[OpenStack]] now exposes a user management API. This enables people deploying
[[OpenStack]] to create custom interfaces to manage users.

= Rationale =

There's no reason why nova-manage should be the only way to admin users, and
there's certainly no reason why people wanting to do this should talk directly
to the DB or to LDAP.

= User stories =

Andrew wants to deploy [[OpenStack]] as a public cloud service. His company already
has a web portal, and they want to be able to hook into [[OpenStack]]'s user db.

= Implementation =

Through the EC2 API, these API calls will be exposed:

* CreateUser
* DescribeUser
* DestroyUser

== [[CreateUser]] ==

CreateUser takes a single argument:
{| border="1" cellpadding="2" cellspacing="0"
| Name
|-
| AccessKey
|-
| SecretKey
|-
| Admin
|}

If succesful, the API call will return:
{| border="1" cellpadding="2" cellspacing="0"
| Name
|-
| AccessKey
|-
| SecretKey
|-
| Admin
|}

== [[DescribeUser]] ==

DescribeUser takes one of the following arguments:
{| border="1" cellpadding="2" cellspacing="0"
| Name
|-
| AccessKey
|}

If succesful, the API call will return:
{| border="1" cellpadding="2" cellspacing="0"
| Name
|-
| AccessKey
|-
| SecretKey
|-
| Admin
|}

== [[DestroyUser]] ==

DestroyUser takes a single argument:
{| border="1" cellpadding="2" cellspacing="0"
| Name
|}

== Test/Demo Plan ==

This need not be added or completed until the specification is nearing beta.

----
[[Category:Spec]]

@@ Line 1: / Line 1: @@
-* '''Launchpad Entry''': [[NovaSpec]]:auth-manager-api
+* '''Launchpad Entry''': NovaSpec:auth-manager-api
 * '''Created''': 2010-10-28
 * '''Contributors''': Soren Hansen

@@ Line 29: / Line 29: @@
 * CreateUser
-* DescribeUser
+* DescribeUsers
 * DestroyUser
@@ Line 58: / Line 58: @@
 == [[DescribeUser]] ==
-DescribeUser takes one of the following arguments:
+DescribeUsers takes the following arguments:
 {| border="1" cellpadding="2" cellspacing="0"
 |  Name
@@ Line 65: / Line 65: @@
 |}
-If succesful, the API call will return:
+Both are optional. If none are given, a complete list of users is returned.
 {| border="1" cellpadding="2" cellspacing="0"
 |  Name