User options are not documented in the API reference

Bug #1792026 reported by Lance Bragstad on 2018-09-11
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Medium
Lance Bragstad

Bug Description

Keystone has user options that are useful for various PCI-DSS features among other things. We do highlight some of this in the PCI-DSS documentation [0], but we don't formally document it in the API reference.

[0] https://docs.openstack.org/keystone/latest/admin/identity-security-compliance.html#setting-an-account-lockout-threshold

tags: added: docum
tags: added: documentation low-hanging-fruit office-hours
removed: docum
Changed in keystone:
status: New → Triaged
importance: Undecided → Medium
Chason Chan (chen-xing) on 2018-09-18
Changed in keystone:
assignee: nobody → Chason Chan (chen-xing)

Fix proposed to branch: master
Review: https://review.openstack.org/603319

Changed in keystone:
status: Triaged → In Progress
Colleen Murphy (krinkle) wrote :

Unfortunately the best source of information on user options as far as I can find is in the code: http://git.openstack.org/cgit/openstack/keystone/tree/keystone/identity/backends/resource_options.py?h=14.0.0

Fix proposed to branch: master
Review: https://review.openstack.org/618823

Changed in keystone:
assignee: Chason Chan (chen-xing) → Lance Bragstad (lbragstad)

Reviewed: https://review.openstack.org/618823
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=7f8c1a306941c626baa2529ad2f149c8e026352f
Submitter: Zuul
Branch: master

commit 7f8c1a306941c626baa2529ad2f149c8e026352f
Author: Lance Bragstad <email address hidden>
Date: Mon Nov 19 20:24:29 2018 +0000

    Document user options

    User options have been available in keystone for a few releases but
    there isn't any official documentation for them.

    This commit add a general section to the administrator guide that
    attempts to describe each options and its type.

    Change-Id: Ib0cc07236ba9083c2a35bf8ac6444ccfd19b7219
    Related-Bug: 1792026

Reviewed: https://review.openstack.org/603319
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=325d9eea3352d052972bac390d30dcf0f3635291
Submitter: Zuul
Branch: master

commit 325d9eea3352d052972bac390d30dcf0f3635291
Author: chenxing <email address hidden>
Date: Tue Sep 18 16:22:02 2018 +0800

    Update api-ref to include user options

    This commit formally adds resources options for users to the
    identity API reference. Descriptions of the behavior provided
    by each option is left to the administrator guide, but the
    examples here at least show how to access and use the options
    implemented for users.

    Co-Authored-By: Lance Bragstad <email address hidden>
    Closes-Bug: #1792026
    Change-Id: I5af3761e42dfe544431ae0bd4b2c032391023bcc

Changed in keystone:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers