Skip to content

Commit

Permalink
docs: update docs/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Aug 11, 2021
1 parent e1531c3 commit 772306c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/README.md
Expand Up @@ -308,7 +308,7 @@ Performs the callback for Authorization Server's authorization response.
- `clientAssertionPayload`: `<Object>` extra client assertion payload parameters to be sent as
part of a client JWT assertion. This is only used when the client's `token_endpoint_auth_method`
is either `client_secret_jwt` or `private_key_jwt`.
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Token Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<TokenSet>` Parsed token endpoint response as a TokenSet.
Expand All @@ -332,7 +332,7 @@ Performs `refresh_token` grant type exchange.
- `clientAssertionPayload`: `<Object>` extra client assertion payload parameters to be sent as
part of a client JWT assertion. This is only used when the client's `token_endpoint_auth_method`
is either `client_secret_jwt` or `private_key_jwt`.
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Token Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<TokenSet>` Parsed token endpoint response as a TokenSet.
Expand All @@ -355,7 +355,7 @@ will also be checked to match the on in the TokenSet's ID Token.
or the `token_type` property from a passed in TokenSet.
- `params`: `<Object>` additional parameters to send with the userinfo request (as query string
when GET, as x-www-form-urlencoded body when POST).
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Userinfo Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<Object>` Parsed userinfo response.
Expand All @@ -375,7 +375,7 @@ Fetches an arbitrary resource with the provided Access Token in an Authorization
- `method`: `<string>` The HTTP method to use for the request. **Default:** 'GET'
- `tokenType`: `<string>` The token type as the Authorization Header scheme. **Default:** 'Bearer'
or the `token_type` property from a passed in TokenSet.
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Userinfo Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<Response>` Response is a [Got Response](https://github.com/sindresorhus/got/tree/v11.8.0#response)
Expand All @@ -395,7 +395,7 @@ Performs an arbitrary `grant_type` exchange at the `token_endpoint`.
- `clientAssertionPayload`: `<Object>` extra client assertion payload parameters to be sent as
part of a client JWT assertion. This is only used when the client's `token_endpoint_auth_method`
is either `client_secret_jwt` or `private_key_jwt`.
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Token Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<TokenSet>`
Expand Down Expand Up @@ -471,7 +471,7 @@ a handle for subsequent Device Access Token Request polling.
- `clientAssertionPayload`: `<Object>` extra client assertion payload parameters to be sent as
part of a client JWT assertion. This is only used when the client's `token_endpoint_auth_method`
is either `client_secret_jwt` or `private_key_jwt`.
- `DPoP`: `KeyObject` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
- `DPoP`: `<KeyObject>` &vert; `<Object>` When provided the client will send a DPoP Proof JWT to the
Token Endpoint. The value should be a private key to sign a DPoP Proof JWT with. This can be
a crypto.KeyObject, crypto.createPrivateKey valid inputs, or a JWK formatted private key.
- Returns: `Promise<DeviceFlowHandle>`
Expand Down

0 comments on commit 772306c

Please sign in to comment.