You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2019/08/30 07:41:20 UTC
[GitHub] [pulsar] Jennifer88huang commented on a change in pull request
#5052: [doc] Improve Pulsar Security-token-admin
Jennifer88huang commented on a change in pull request #5052: [doc] Improve Pulsar Security-token-admin
URL: https://github.com/apache/pulsar/pull/5052#discussion_r319389854
##########
File path: site2/docs/security-token-admin.md
##########
@@ -6,96 +6,87 @@ sidebar_label: Token authentication admin
## Token Authentication Overview
-Pulsar supports authenticating clients using security tokens that are based on
-[JSON Web Tokens](https://jwt.io/introduction/) ([RFC-7519](https://tools.ietf.org/html/rfc7519)).
+Pulsar supports authenticating clients using security tokens that are based on [JSON Web Tokens](https://jwt.io/introduction/) ([RFC-7519](https://tools.ietf.org/html/rfc7519)).
-Tokens are used to identify a Pulsar client and associate with some "principal" (or "role") which
-will be then granted permissions to do some actions (eg: publish or consume from a topic).
+You can use tokens to identify a Pulsar client and associate with some "principal" (or "role") that
+is permitted to do some actions (for example, publish to a topic or consume from a topic).
-A user will typically be given a token string by an administrator (or some automated service).
+A user typically gets a user a token string from the administrator (or some automated service).
-The compact representation of a signed JWT is a string that looks like:
+The compact representation of a signed JWT is a string that looks like as the follwing:
```
- eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
- ```
+eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
+```
+
+Application specifies the token when you are creating the client instance. An alternative is to pass a "token supplier" (a function that returns the token when the client library needs one).
Review comment:
Check the first sentence, and pay attention to two points:
1. the word "specifies"
2. use present tense.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services