From 718e3094d503533ef4d2108522a6fa88b34384f8 Mon Sep 17 00:00:00 2001 From: Yogeshwar Srikrishnan Date: Fri, 10 Jun 2011 13:19:01 -0500 Subject: Doc updates. --- docs/guide/src/docbkx/identitydevguide.xml | 157 +++++++++++++++++++++++++++-- docs/guide/src/docbkx/samples/group.json | 1 + docs/guide/src/docbkx/samples/group.xml | 4 + docs/guide/src/docbkx/samples/groups.json | 1 + docs/guide/src/docbkx/samples/groups.xml | 5 + 5 files changed, 161 insertions(+), 7 deletions(-) mode change 100644 => 100755 docs/guide/src/docbkx/identitydevguide.xml create mode 100644 docs/guide/src/docbkx/samples/group.json create mode 100644 docs/guide/src/docbkx/samples/group.xml create mode 100644 docs/guide/src/docbkx/samples/groups.json create mode 100644 docs/guide/src/docbkx/samples/groups.xml (limited to 'docs/guide') diff --git a/docs/guide/src/docbkx/identitydevguide.xml b/docs/guide/src/docbkx/identitydevguide.xml old mode 100644 new mode 100755 index 5af5c532..8cd562c6 --- a/docs/guide/src/docbkx/identitydevguide.xml +++ b/docs/guide/src/docbkx/identitydevguide.xml @@ -858,6 +858,49 @@ Host: identity.api.openstack.org/v1.1/
Core Admin API Proposal The following table of calls is proposed as core Keystone Admin APIs +
+ Users + + &LONG_URI_REFHEAD; + + + &POST; + /users + Get a list of users. + + + &GET; + /users/userId + Get a user. + + + &PUT; + /users/userId + Update a user. + + + &DELETE; + /users/userId + Delete a user. + + + &PUT; + /users/userId/password + Update a user password. + + + &PUT; + /users/userId/enabled + Enable/Disable user. + + + &PUT; + /users/userId/tenant + Update user tenant. + + + +
Tokens @@ -887,15 +930,65 @@ Host: identity.api.openstack.org/v1.1/ /tenants Get a list of tenants. - - &GET; - /tenants/tenantId - Get a tenant. - + + &GET; + /tenants/tenantId + Get a tenant. + + + &POST; + /tenants + Create a tenant. + + + &PUT; + /tenants/tenantId + Update a tenant. + + + &DELETE; + /tenants/tenantId + Delete a tenant. + + + &GET; + /tenants/tenantId/groups + Get a list of tenant groups. + + + &POST; + /tenants/tenantId/groups + Create a tenant group. + + + &GET; + /tenants/tenantId/groups/groupId + Get a tenant group with the specified id. + + + &PUT; + /tenants/tenantId/groups/groupId + Update a tenant group. + + + &GET; + /tenants/tenantId/groups/groupId/users + get tenant group users. + + + &PUT; + /tenants/tenantId/groups/groupId/users/userId + Add a user to a tenant group. + + + &DELETE; + /tenants/tenantId/groups/groupId/users/userId + Delete user tenant group. + -
- +
+
Endpoints (BaseURLs) @@ -1008,6 +1101,56 @@ Host: identity.api.openstack.org/v1.1/
+ +
+ Global Groups + + &LONG_URI_REFHEAD; + + + &POST; + /groups + Create a global group. + + + &GET; + /groups + Get a list of global groups. + + + &GET; + /groups/groupId + Get a global group. + + + &PUT; + /groups/groupId + Update a global group. + + + &DELETE; + /groups/groupId + Delete a global group. + + + &GET; + /groups/groupId/users + Get a list of users of a global group. + + + &PUT; + /groups/groupId/users/userId + Add user to a global group. + + + &DELETE; + /groups/groupId/users/userId + Delete user from a global group. + + + +
+ All other APIs listed in this section will be extensions used for this reference implementation of Keystone to support user and tenant management diff --git a/docs/guide/src/docbkx/samples/group.json b/docs/guide/src/docbkx/samples/group.json new file mode 100644 index 00000000..07dc0a10 --- /dev/null +++ b/docs/guide/src/docbkx/samples/group.json @@ -0,0 +1 @@ +{"group": {"id": "test_global_group", "description": "A description ..."}} \ No newline at end of file diff --git a/docs/guide/src/docbkx/samples/group.xml b/docs/guide/src/docbkx/samples/group.xml new file mode 100644 index 00000000..0f285307 --- /dev/null +++ b/docs/guide/src/docbkx/samples/group.xml @@ -0,0 +1,4 @@ + + + A Description of the group + diff --git a/docs/guide/src/docbkx/samples/groups.json b/docs/guide/src/docbkx/samples/groups.json new file mode 100644 index 00000000..06dd58a0 --- /dev/null +++ b/docs/guide/src/docbkx/samples/groups.json @@ -0,0 +1 @@ +{"groups": {"values": [{"id": "test_global_group_add", "description": "A description ..."}], "links": []}} \ No newline at end of file diff --git a/docs/guide/src/docbkx/samples/groups.xml b/docs/guide/src/docbkx/samples/groups.xml new file mode 100644 index 00000000..a429fdb3 --- /dev/null +++ b/docs/guide/src/docbkx/samples/groups.xml @@ -0,0 +1,5 @@ + + + A Description of the group + + -- cgit