New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Splits the token APIs into separate pages #32865

Merged

lcawl merged 8 commits into elastic:master from lcawl:lcawley-token-apis

Aug 18, 2018

Contributor

lcawl commented Aug 15, 2018

The Tokens API documentation (https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-tokens.html) currently contains information about multiple APIs (get and delete). This PR splits that information across multiple pages, mirroring the layout of the machine learning APIs and OpenAPI output.

This layout change was discussed briefly in #32635 (comment).
Related to #32794, #32825, and #32797

lcawl added >docs v7.0.0 :Security/Authentication v6.4.0 v6.3.1 v6.5.0 labels

lcawl requested a review from jaymode

August 15, 2018 17:01

jaymode reviewed

View reviewed changes

Member

jaymode left a comment

I left some minor comments. Otherwise LGTM

x-pack/docs/en/rest-api/security/delete-tokens.asciidoc Outdated

    
              `xpack.security.authc.token.timeout` setting. For more information, see 

              <<token-service-settings>>.

              If you want to invalidate a token immediately, use this delete tokens API.

Member

jaymode Aug 17, 2018

s/tokens/token

x-pack/docs/en/rest-api/security/get-tokens.asciidoc Outdated

    
              you are running in production mode, a bootstrap check prevents you from enabling 

              the token service unless you also enable TLS on the HTTP interface. 

              The get tokens API takes the same parameters as a typical OAuth 2.0 token API

Member

jaymode Aug 17, 2018

s/tokens/token

x-pack/docs/en/rest-api/security/get-tokens.asciidoc Outdated

    
              The get tokens API takes the same parameters as a typical OAuth 2.0 token API

              except for the use of a JSON request body.

              A successful get tokens API call returns a JSON structure that contains the access

Member

jaymode Aug 17, 2018

s/tokens/token

x-pack/docs/en/rest-api/security/get-tokens.asciidoc Outdated

    
              token, the amount of time (seconds) that the token expires in, the type, and the

              scope if available.

              The tokens returned by the get tokens API have a finite period of time for which

Member

jaymode Aug 17, 2018

s/tokens/token

x-pack/docs/en/rest-api/security/get-tokens.asciidoc Outdated

    
              `grant_type`::

              (string) The type of grant. Currently only the `password` grant type is supported.

              //TBD: What about the `refresh_token` type in the example below?

Member

jaymode Aug 17, 2018

refresh_token is also valid now

x-pack/docs/en/rest-api/security/get-tokens.asciidoc Outdated

    
              `password` (required)::

              (string) The user's password.

              //TBD: Add `refresh_token` parameter per example below?

Member

jaymode Aug 17, 2018

Yes we need to add this as well. When grant type is refresh_token then username and password are not required but the refresh_token field is required.

Contributor Author

lcawl commented Aug 17, 2018

@jaymode I updated the URL in https://github.com/elastic/x-pack-elasticsearch/blob/master/plugin/src/test/resources/rest-api-spec/api/xpack.security.get_token.json, but couldn't find a xpack.security.delete_token.json. Should I create one?

Contributor Author

lcawl commented Aug 17, 2018

Nevermind! I found and update https://github.com/elastic/x-pack-elasticsearch/blob/master/plugin/src/test/resources/rest-api-spec/api/xpack.security.invalidate_token.json

lcawl force-pushed the lcawley-token-apis branch from f9b7dcf to c4b9f4f Compare

August 17, 2018 18:11

lcawl mentioned this pull request

[DOCS] Updates links to token APIs elastic/kibana#22155

Merged

Contributor Author

lcawl commented Aug 17, 2018

retest this please

lcawl force-pushed the lcawley-token-apis branch from c4b9f4f to 2e790b6 Compare

August 17, 2018 23:46

lcawl added 8 commits

August 17, 2018 22:07


          [DOCS] Splits the token APIs into separate pages

7510e9e


          [DOCS] Fixed build error

482d331


          [DOCS] Fixes build errs in delete tokens API

ba7e3bc


          [DOCS] Addresses feedback about the token APIs

0a61235


          [DOCS] Updated URL in xpack.security.get_token.json

4fd8569


          [DOCS] Updates URL in invalidate token spec

ebc3d7b


          [DOCS] Removes inline link in Security APIs

b237832


          [DOCS] Adds redirect for token management APIs

af06c3a

lcawl force-pushed the lcawley-token-apis branch from 0ea75d7 to af06c3a Compare

August 18, 2018 05:21

lcawl merged commit fb1c399 into elastic:master

lcawl deleted the lcawley-token-apis branch

August 18, 2018 05:22

lcawl added a commit that referenced this pull request


          [DOCS] Splits the token APIs into separate pages (#32865)

a68a9f0

lcawl added a commit that referenced this pull request


          [DOCS] Splits the token APIs into separate pages (#32865)

b3f7635

lcawl added a commit that referenced this pull request


          [DOCS] Splits the token APIs into separate pages (#32865)

efff7bb

jasontedor added a commit to jasontedor/elasticsearch that referenced this pull request


          Merge branch 'master' into generalize-remote-license-check

844830d

* master:
  NETWORKING: Make RemoteClusterConn. Lazy Resolve DNS (elastic#32764)
  [DOCS] Splits the users API documentation into multiple pages (elastic#32825)
  [DOCS] Splits the token APIs into separate pages (elastic#32865)
  [DOCS] Creates redirects for role management APIs page
  Bypassing failing test PainlessDomainSplitIT#testHRDSplit (elastic#32966)
  TEST: Mute testRetentionPolicyChangeDuringRecovery
  [DOCS] Fixes more broken links to role management APIs
  [Docs] Tweaks and fixes to rollup docs
  [DOCS] Fixes links to role management APIs
  [ML][TEST] Fix BasicRenormalizationIT after adding multibucket feature
  [DOCS] Splits the roles API documentation into multiple pages (elastic#32794)
  [TEST]  Run pre 6.4 nodes in non-FIPS JVMs (elastic#32901)
  Make Geo Context Mapping Parsing More Strict (elastic#32821)

jasontedor added a commit that referenced this pull request


          Merge remote-tracking branch 'elastic/master' into ccr

ac75968

* elastic/master: (46 commits)
  NETWORKING: Make RemoteClusterConn. Lazy Resolve DNS (#32764)
  [DOCS] Splits the users API documentation into multiple pages (#32825)
  [DOCS] Splits the token APIs into separate pages (#32865)
  [DOCS] Creates redirects for role management APIs page
  Bypassing failing test PainlessDomainSplitIT#testHRDSplit (#32966)
  TEST: Mute testRetentionPolicyChangeDuringRecovery
  [DOCS] Fixes more broken links to role management APIs
  [Docs] Tweaks and fixes to rollup docs
  [DOCS] Fixes links to role management APIs
  [ML][TEST] Fix BasicRenormalizationIT after adding multibucket feature
  [DOCS] Splits the roles API documentation into multiple pages (#32794)
  [TEST]  Run pre 6.4 nodes in non-FIPS JVMs (#32901)
  Make Geo Context Mapping Parsing More Strict (#32821)
  [ML] fix updating opened jobs scheduled events (#31651) (#32881)
  Scripted metric aggregations: add deprecation warning and system property to control legacy params (#31597)
  Tests: Fix timezone conversion in DateTimeUnitTests
  Enable FIPS140LicenseBootstrapCheck (#32903)
  Fix InternalAutoDateHistogram reproducible failure (#32723)
  Remove assertion in testDocStats on deletedDocs counter (#32914)
  HLRC: Move ML request converters into their own class (#32906)
  ...

jasontedor added a commit that referenced this pull request


          Merge branch '6.x' into ccr-6.x

a9517e7

* 6.x: (42 commits)
  [DOCS] Splits the users API documentation into multiple pages (#32825)
  [DOCS] Splits the token APIs into separate pages (#32865)
  [DOCS] Creates redirects for role management APIs page
  Bypassing failing test PainlessDomainSplitIT#testHRDSplit (#32966)
  TEST: Mute testRetentionPolicyChangeDuringRecovery
  [DOCS] Fixes more broken links to role management APIs
  [Docs] Tweaks and fixes to rollup docs
  [DOCS] Fixes links to role management APIs
  [ML][TEST] Fix BasicRenormalizationIT after adding multibucket feature
  [DOCS] Splits the roles API documentation into multiple pages (#32794)
  [TEST]  Run pre 6.4 nodes in non-FIPS JVMs (#32901)
  Remove assertion in testDocStats on deletedDocs counter (#32914)
  [ML] fix updating opened jobs scheduled events (#31651) (#32881)
  Enable FIPS140LicenseBootstrapCheck (#32903)
  HLRC: Move ML request converters into their own class (#32906)
  [DOCS] Update getting-started.asciidoc (#29518)
  Fix allowed value for HighlighterBuilder encoder in javadocs (#32780)
  [DOCS] Add "remove a tag" script logic as an example (#32556)
  RFC: Test that example plugins build stand-alone (#32235)
  Security: remove put privilege API (#32879)
  ...

colings86 added v7.0.0-beta1 and removed v7.0.0 labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs :Security/Authentication v6.3.1 v6.4.0 v6.5.0 v7.0.0-beta1