diff --git a/api-ref-guides/pom.xml b/api-ref-guides/pom.xml index dce9c319b..7c0162125 100644 --- a/api-ref-guides/pom.xml +++ b/api-ref-guides/pom.xml @@ -31,7 +31,6 @@ locale - com.rackspace.cloud.api diff --git a/api-ref/src/docbkx/ch_identity-admin-v2.xml b/api-ref/src/docbkx/ch_identity-admin-v2.xml index 6e96ba815..63e7c07cb 100644 --- a/api-ref/src/docbkx/ch_identity-admin-v2.xml +++ b/api-ref/src/docbkx/ch_identity-admin-v2.xml @@ -2,34 +2,76 @@ Identity admin API v2.0 (STABLE) Get an authentication token that permits access to the Compute API. - - - - - - - - - - - - - - - - - - - - - - - - - +
+ Versions + + + + + +
+
+ Extensions + + + + + + + + +
+
+ Tokens + + + + + + + + + +
+
+ Users + + + + + + + + + + + + + + + + + + +
+
+ Tenants + + + + + + + + + + + + +
diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl index da3f3f855..257f6c4f3 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity-admin.wadl @@ -12,7 +12,6 @@ ]> - - - - - - - + + + + + + + The extension name. + + + - + @@ -61,13 +63,15 @@ Optional. The tenant ID. - - - + + + Required. The token ID. - + Validates that a token has the specified tenant in scope, for performance. Valid tokens are in the /tokens/{tokenId} @@ -75,65 +79,85 @@ token that is not valid. - - - - + + + + - - + + A valid authentication token for an administrative user. - - + + + + + The ID of the user for which you want to perform the + request. + + + + + + + The user name. - + - - + + The user ID. - - - + + + - - + + A valid authentication token for an administrative user. - + The ID of the last item in the previous list. - + The page size. - - - - + + + + The tenant ID. - - - - + + + + The user ID. - - + + @@ -146,23 +170,24 @@ - + - - A list of supported extensions. + + Lists supported extensions. - + - + Gets detailed information about a specified version of the Identity API. - + + @@ -175,50 +200,54 @@ - &commonFaults; &getFaults; - - - Lists available extensions. + + + Lists available extensions. - + + + + + + + + + - Moves to the next - item in the list. + + Moves to the next item in the list. + - Moves to the - previous item in the list. + + Moves to the previous item in the list. + - - - - - - - &commonFaults; &getFaults; - - - Gets detailed information for a specified extension. + + + Gets detailed information for a specified extension. + Specify the extension alias in the URI. @@ -228,18 +257,16 @@ - + &commonFaults; &getFaults; - + Authenticates and generates a token. @@ -259,7 +286,8 @@ Identity treats expired tokens as invalid tokens. The deployment determines how long expired tokens are stored. - + + @@ -272,43 +300,50 @@ - + The tenant name. Both the tenantId and tenantName attributes are optional, but should not be specified together. If both attributes are specified, the server responds with a 400 Bad Request. - + The tenant ID. Both the tenantId and tenantName attributes are optional, but should not be specified together. If both attributes are specified, the server responds with a 400 Bad Request. - + A passwordCredentials object. To authenticate, you must provide either a user ID and password or a token. - + The user name. Required if you include the passwordCredentials object. If you do not provide a password credentials, you must provide a token. - + The password of the user. Required if you include the passwordCredentials object. If you do not provide a password credentials, you must provide a token. - + A token object. Required if you do not provide password credentials. - + The token ID. This is a required field in the token object. @@ -328,8 +363,8 @@ - + + @@ -342,76 +377,93 @@ - + An access object. - + A token object. - + A timestamp that indicates when the token was issued. - + A timestamp that indicates when the token expires. - + The authentication token. In the example, the token is my_id. - + A tenant object. - + The description of the tenant. If not set, this value is null. - + Indicates whether the tenant is enabled or disabled. - + The tenant ID. - + The tenant name. - + A serviceCatalog object. - + One or more endpoints objects. Each object shows the adminURL, region, internalURL, id, and publicURL for the endpoint. - + Links for the endpoint. - + Endpoint type. - + Endpoint name. - + A user object, which shows the username, roles_links, id, roles, and name. - + A metadata object. @@ -420,7 +472,7 @@ &commonFaults; &getFaults; - + Validates a token and confirms that it belongs to a specified tenant. @@ -444,13 +496,13 @@ &commonFaults; &getFaults; - + Validates a token and confirms that it belongs to a specified tenant, for performance. &commonFaults; &getFaults; - + Lists the endpoints associated with a specified token. @@ -473,15 +525,80 @@ &commonFaults; &getFaults; - - + + + Adds a user. + + + + + + + + The user + name. + + + + + + + + + + + + + + + + + + + + &commonFaults; &getFaults; &postPutFaults; + + + Updates a user. + + + + + + + + + + + + + + + + + + + + + + + + + &commonFaults; &postPutFaults; &getFaults; + + + Deletes a user. + + &commonFaults; &getFaults; + Gets detailed information about a specified user by user name. - + Lists all tenants. @@ -566,7 +683,7 @@ &commonFaults; &getFaults; - + Gets detailed information about a specified tenant by @@ -574,7 +691,8 @@ - + The name of the tenant. @@ -596,7 +714,7 @@ &commonFaults; &getFaults; - + Gets detailed information about a specified tenant by ID. @@ -617,7 +735,7 @@ &commonFaults; &getFaults; - + Lists roles for a specified user on a specified tenant. Excludes global roles. diff --git a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl index e0379be12..c6c664a6b 100644 --- a/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl +++ b/api-ref/src/wadls/identity-api/src/v2.0/wadl/identity.wadl @@ -13,7 +13,6 @@ ]> - + - - The extension - name. + + + The extension name. + @@ -48,22 +44,20 @@ - - A valid authentication - token. + + + A valid authentication token. + - - The ID of the last item in the - previous list. + + + The ID of the last item in the previous list. + - - The page size. + + + The page size. + @@ -76,8 +70,7 @@ - + Lists supported extensions. @@ -87,130 +80,94 @@ - Lists information about all Identity - API versions. + Lists information about all Identity API versions. - - + + - - + + &commonFaults; &getFaults; - - Shows details for the Identity API - v2.0. + + Shows details for the Identity API v2.0. - - + + - + - - + + &commonFaults; &getFaults; - + Lists available extensions. - - + - - + + - + - + - - Moves to the next item in the - list. + + Moves to the next item in the list. - - Moves to the previous item in the - list. + + Moves to the previous item in the list. - + &commonFaults; &getFaults; - - Gets detailed information for a - specified extension. + + Gets detailed information for a specified extension. Specify the extension alias in the URI. - + - + - + @@ -218,145 +175,94 @@ &commonFaults; &getFaults; - - Authenticates and generates a - token. - The Identity API is a ReSTful web service. It is the - entry point to all service APIs. To access the - Identity API, you must know its URL. - Each ReST request against Identity requires the - X-Auth-Token header. Clients obtain this token, along - with the URL to other service APIs, by first - authenticating against Identity with valid - credentials. - To authenticate, you must provide either a user ID - and password or a token. - If the authentication token has expired, a - 401 response code is - returned. - If the token specified in the request has expired, - this call returns a 404 - response code. - Identity treats expired tokens as invalid - tokens. - The deployment determines how long expired tokens - are stored. + + Authenticates and generates a token. + The Identity API is a ReSTful web service. It is the entry point to all service + APIs. To access the Identity API, you must know its URL. + Each ReST request against Identity requires the X-Auth-Token header. Clients + obtain this token, along with the URL to other service APIs, by first authenticating + against Identity with valid credentials. + To authenticate, you must provide either a user ID and password or a token. + If the authentication token has expired, a 401 response + code is returned. + If the token specified in the request has expired, this call returns a + 404 response code. + Identity treats expired tokens as invalid tokens. + The deployment determines how long expired tokens are stored. - + - + - + - + - - The tenant name. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are - specified, the server responds with a - 400 - Bad - Request. + + The tenant name. Both the + tenantId and tenantName attributes are + optional, but should not be specified together. If both attributes are + specified, the server responds with a 400 + Bad Request. - - The tenant ID. Both the - tenantId and - tenantName attributes are - optional, but should not be specified - together. If both attributes are - specified, the server responds with a - 400 - Bad - Request. + + The tenant ID. Both the + tenantId and tenantName attributes are + optional, but should not be specified together. If both attributes are + specified, the server responds with a 400 + Bad Request. - - A passwordCredentials - object. To authenticate, you must provide - either a user ID and password or a - token. + + A + passwordCredentials object. To authenticate, you must + provide either a user ID and password or a token. - - The user name. Required if you - include the - passwordCredentials - object. If you do not provide a password - credentials, you must provide a - token. + + The user name. Required if + you include the passwordCredentials object. If you do not + provide a password credentials, you must provide a + token. - - The password of the user. Required - if you include the - passwordCredentials - object. If you do not provide a password - credentials, you must provide a + + The password of the user. + Required if you include the passwordCredentials object. If + you do not provide a password credentials, you must provide a token. - - A token object. - Required if you do not provide password - credentials. + + A token + object. Required if you do not provide password + credentials. - - The token ID. This is a required - field in the token - object. + + The token ID. This is a + required field in the token object. - + - - + + - + - - + + - - - - + - - An access + + An access object. - - A token - object. + + A token + object. - - A timestamp that indicates when the - token was issued. + + A timestamp that indicates + when the token was issued. - - A timestamp that indicates when the - token expires. + + A timestamp that indicates + when the token expires. - - The authentication token. In the - example, the token is - my_id. + + The authentication token. + In the example, the token is my_id. - - A tenant + + A tenant object. - - The description of the tenant. If - not set, this value is - null. + + The description of the + tenant. If not set, this value is null. - - Indicates whether the tenant is - enabled or disabled. + + Indicates whether the + tenant is enabled or disabled. - - The tenant ID. + + The tenant + ID. - - The tenant name. + + The tenant + name. - - A serviceCatalog - object. + + A + serviceCatalog object. - - One or more endpoints - objects. Each object shows the - adminURL, - region, - internalURL, - id, and - publicURL for the - endpoint. + + One or more + endpoints objects. Each object shows the + adminURL, region, + internalURL, id, and publicURL + for the endpoint. - - Links for the - endpoint. + + Links for the + endpoint. - - Endpoint type. + + Endpoint + type. - - Endpoint name. + + Endpoint + name. - - A user object, which - shows the username, - roles_links, - id, roles, - and name. + + A user + object, which shows the username, roles_links, + id, roles, and + name. - - A metadata + + A metadata object. - + &commonFaults; &getFaults; - - Lists tenants to which the - specified token has access. + + Lists tenants to which the specified token has access. - + - - + + - + - - + + @@ -527,8 +385,7 @@ - + diff --git a/pom.xml b/pom.xml index b4241495b..8c71cab64 100644 --- a/pom.xml +++ b/pom.xml @@ -39,7 +39,7 @@ com.rackspace.cloud.api clouddocs-maven-plugin - 2.1.1 + 2.1.2