Updates README with minor changes #425
Conversation
vijetmahabaleshwar-okta
requested review from
arvindkrishnakumar-okta and
bdemers
| @@ -92,7 +92,7 @@ Snapshots are deployed off of the 'master' branch to [OSSRH](https://oss.sonatyp | |||
| https://oss.sonatype.org/content/repositories/snapshots/ | |||
| ``` | |||
|
|
|||
| You'll also need: | |||
There was a problem hiding this comment.
To maintain consistency, as we have used You will in other sentences.
| @@ -104,8 +104,8 @@ Construct a client instance by passing it your Okta domain name and API token: | |||
| [//]: # (method: createClient) | |||
| ```java | |||
| Client client = Clients.builder() | |||
| .setOrgUrl("{yourOktaDomain}") | |||
| .setClientCredentials(new TokenClientCredentials("{apiToken}")) | |||
There was a problem hiding this comment.
Having these brackets is confusing for some users, who tend to include them while adding values. I've seen users ask questions about it on devforum.
| - okta.apps.read | ||
| privateKey: "~/.okta/privateKey.pem" # PEM format. This SDK supports RSA AND EC algorithms - RS256, RS384, RS512, ES256, ES384, ES512. | ||
| clientId: "yourClientId" | ||
| scopes: "okta.users.read okta.apps.read" |
There was a problem hiding this comment.
Right now, multi line scopes is not working as expected. @arvindkrishnakumar-okta is aware of the issue. Once he fixes it, we can update the README if needed.
There was a problem hiding this comment.
@vijetmahabaleshwar-okta I just recalled that this issue was already noticed and fixed (see #379). Please build the latest SDK from master and inject it into your client app to get past this.
README.md
Outdated
|
|
||
| [//]: # (method: createOAuth2Client) | ||
| ```java | ||
| Client client = Clients.builder() | ||
| .setOrgUrl("{yourOktaDomain}") | ||
| .setOrgUrl("https://{yourOktaDomain}") // E.g https://dev-123456.okta.com |
There was a problem hiding this comment.
| .setOrgUrl("https://{yourOktaDomain}") // E.g https://dev-123456.okta.com | |
| .setOrgUrl("https://{yourOktaDomain}") // e.g. https://dev-123456.okta.com |
README.md
Outdated
| @@ -104,8 +104,8 @@ Construct a client instance by passing it your Okta domain name and API token: | |||
| [//]: # (method: createClient) | |||
| ```java | |||
| Client client = Clients.builder() | |||
| .setOrgUrl("{yourOktaDomain}") | |||
| .setClientCredentials(new TokenClientCredentials("{apiToken}")) | |||
| .setOrgUrl("https://{yourOktaDomain}") // E.g https://dev-123456.okta.com | |||
There was a problem hiding this comment.
| .setOrgUrl("https://{yourOktaDomain}") // E.g https://dev-123456.okta.com | |
| .setOrgUrl("https://{yourOktaDomain}") // e.g. https://dev-123456.okta.com |
Codecov Report
@@ Coverage Diff @@
## master #425 +/- ##
============================================
- Coverage 71.81% 71.71% -0.10%
+ Complexity 1284 1283 -1
============================================
Files 129 129
Lines 4172 4172
Branches 677 677
============================================
- Hits 2996 2992 -4
- Misses 931 933 +2
- Partials 245 247 +2
Continue to review full report at Codecov.
|
vijetmahabaleshwar-okta
force-pushed
the
vm-update-readme
branch
from
a07a416
to
3a5acc4
Compare
Issue(s)
Description
Category