PCI-DSS Adds password_expires_at to API docs

This patch adds a new user response attribute, password_expires_at,
to the Identity API v3 documentation.

Passord expires validation implementation:
https://review.openstack.org/333360

Depends-On: I07c10de627898d6ac79578dc24292ded4a2190f1
Partially-implements: blueprint pci-dss
Change-Id: I37136f79488d7469f0b8b24e3f5628899e40cac0

api-ref/source/v3/parameters.yaml

@@ -1328,6 +1328,17 @@ password:
   in: body
   required: true
   type: string
+password_expires_at:
+  description: |
+    The date and time when the password expires. The time zone
+    is UTC.
+
+    This is a response object attribute; not valid for requests.
+    A ``null`` value indicates that the password never expires.
+  in: body
+  required: true
+  type: string
+  min_version: 3.7
 password_request_body:
   description: |
     The password for the user.

api-ref/source/v3/samples/admin/group-users-list-response.json

@@ -19,11 +19,12 @@
             "domain_id": "default",
             "description": null,
             "enabled": true,
-            "id": "fff603a0829d41e48bc0dd0d72ad61ce"
+            "id": "fff603a0829d41e48bc0dd0d72ad61ce",
             "name": "Paul",
             "links": {
                 "self": "http://example.com/identity/v3/users/fff603a0829d41e48bc0dd0d72ad61ce"
-            }
+            },
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         }
     ]
 }

api-ref/source/v3/samples/admin/user-create-response.json

@@ -9,6 +9,7 @@
         "links": {
             "self": "https://example.com/identity/v3/users/ff4e51"
         },
-        "name": "James Doe"
+        "name": "James Doe",
+        "password_expires_at": "2016-11-06T15:32:17.000000"
     }
 }

api-ref/source/v3/samples/admin/user-show-response.json

@@ -7,6 +7,7 @@
         "links": {
             "self": "https://example.com/identity/v3/users/9fe1d3"
         },
-        "name": "jsmith"
+        "name": "jsmith",
+        "password_expires_at": "2016-11-06T15:32:17.000000"
     }
 }

api-ref/source/v3/samples/admin/user-update-response.json

@@ -7,6 +7,7 @@
         "links": {
             "self": "https://example.com/identity/v3/users/ff4e51"
         },
-        "name": "jamesdoe"
+        "name": "jamesdoe",
+        "password_expires_at": "2016-11-06T15:32:17.000000"
     }
 }

api-ref/source/v3/samples/admin/users-list-response.json

@@ -12,7 +12,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/2844b2a08be147a08ef58317d6471f1f"
             },
-            "name": "glance"
+            "name": "glance",
+            "password_expires_at": null
         },
         {
             "domain_id": "default",
@@ -21,7 +22,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/4ab84ab39de54f4d96eaff8f2145a7cd"
             },
-            "name": "swiftusertest1"
+            "name": "swiftusertest1",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -30,7 +32,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/56696a9a04864d63877a3d06a6f0b24b"
             },
-            "name": "swift"
+            "name": "swift",
+            "password_expires_at": null
         },
         {
             "domain_id": "default",
@@ -39,7 +42,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/5acb638d15da44fc8de41b9a4bd41875"
             },
-            "name": "alt_demo"
+            "name": "alt_demo",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -48,7 +52,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/7596e862b1af473c8ed6ae99d35b51e3"
             },
-            "name": "demo"
+            "name": "demo",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -57,7 +62,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/802edb2141b44e77bbde241417450749"
             },
-            "name": "nova"
+            "name": "nova",
+            "password_expires_at": null
         },
         {
             "domain_id": "592ab0800d3745baaf45c610fa41950a",
@@ -66,7 +72,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/9aca3883784647fe9aff3a50d922489a"
             },
-            "name": "swiftusertest4"
+            "name": "swiftusertest4",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -75,7 +82,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/a1251b011f9345e68c2458b841152034"
             },
-            "name": "swiftusertest3"
+            "name": "swiftusertest3",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -84,7 +92,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/a43f46eb318041f6b712143862e3ad70"
             },
-            "name": "neutron"
+            "name": "neutron",
+            "password_expires_at": null
         },
         {
             "domain_id": "default",
@@ -93,7 +102,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/b964a9e51c0046a4a84d3f83a135a97c"
             },
-            "name": "admin"
+            "name": "admin",
+            "password_expires_at": null
         },
         {
             "domain_id": "default",
@@ -102,7 +112,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/dc87e591c0d247d5ac04e873bd8a1646"
             },
-            "name": "cinder"
+            "name": "cinder",
+            "password_expires_at": null
         },
         {
             "domain_id": "default",
@@ -111,7 +122,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/ed214dc1c2c6468b926c96eca6c8aee9"
             },
-            "name": "glance-swift"
+            "name": "glance-swift",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         },
         {
             "domain_id": "default",
@@ -120,7 +132,8 @@
             "links": {
                 "self": "http://example.com/identity/v3/users/f4f6587b058a4f46a00242549b430d37"
             },
-            "name": "swiftusertest2"
+            "name": "swiftusertest2",
+            "password_expires_at": "2016-11-06T15:32:17.000000"
         }
     ]
 }

api-ref/source/v3/users.inc

@@ -46,6 +46,7 @@ Response Parameters
    - id: id_user_body
    - links: links_user
    - name: user_name_response_body
+   - password_expires_at: password_expires_at
 
 Response Example
 ----------------
@@ -99,6 +100,7 @@ Response Parameters
    - id: id_user_body
    - links: links_user
    - name: user_name_response_body
+   - password_expires_at: password_expires_at
 
 Response Example
 ----------------
@@ -213,6 +215,7 @@ Response Parameters
    - id: id_user_body
    - links: links_user
    - name: user_name_response_body
+   - password_expires_at: password_expires_at
 
 
 List users
@@ -247,6 +250,7 @@ Response Parameters
    - id: id_user_body
    - links: links_user
    - name: user_name_response_body
+   - password_expires_at: password_expires_at
 
 Response Example
 ----------------

releasenotes/notes/add_password_expires_at_to_user_response-22f14ab629c48bc2.yaml

@@ -0,0 +1,4 @@
+---
+upgrade:
+  - We have added the ``password_expires_at`` attribute to
+    the user response object.