Skip to content

Commit

Permalink
Feature/client authentication (#58)
Browse files Browse the repository at this point in the history
* OAuth2 connection update

* small update

* Update README.md

* After closure update

* Update README.md

* Update README.md

* notes updated

* feature/manage-emails

* README.md update

* afterclosure updates & exampls added

* README.md update

* feature/label-management (#3)

* README.md Update 1

* README.md minor updates

* README.md minor updates pt2

* README.md Update pt2

* README.md Update after-closure

* README.md Update

* After-closure update
  • Loading branch information
mouna-elmaazouzi authored Apr 3, 2024
1 parent 0ce9f21 commit df8363e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,15 @@ The available properties of `paramObj` are:
| privateKey | text | (Google / service mode only) Private key given by Google. Mandatory if .permission="service" and .name="Google" |No|
| authenticationPage|text or file object|Path of the web page to display in the web browser when the authentication code is received correctly in signed in mode (If not present the default page is used).|Yes
| authenticationErrorPage |text or file object| Path of the web page to display in the web browser when the authentication server returns an error in signed in mode (If not present the default page is used).|Yes
| PKCEEnabled |boolean| false by default. If true, PKCE is used for OAuth 2.0 authentication and token requests and is only available for permission=”SignIn”. |Yes
| PKCEEnabled |boolean| false by default. If true, PKCE is used for OAuth 2.0 authentication and token requests and is only usable for permission=”SignIn”. |Yes
| PKCEMethod |text | "S256" by default. The only supported values for this parameter are "S256" or "plain". |Yes
| thumbprint |text | Certificate thumbprint. Only usable with permission="Service" | Yes (No for certificate based authentication)
| privateKey | text | Certificate private key. Only usable with permission="Service" | Yes (No for certificate based authentication)
| clientAssertionType | text | The format of the assertion as defined by the authorization server. The value is an absolute URI. Default value: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer". Only usable with permission="Service" |Yes

If you want the .getToken() function to use the Assertion Framework described in the RFC 7521 to connect to the server, make sure to pass the `thumbprint` and `privateKey` properties. If `clientSecret`, `thumbprint` and `privateKey` are present, the `thumbprint` is used by default and the RFC 7521 is used to connect. For more information, please refer to the [OAuth2.0 authentication using a certificate](#https://blog.4d.com/) blog post.


**Note:** The authenticationPage and authenticationErrorPage and all the resources associated must be in the same folder.
**Note:** The `authenticationPage` and `authenticationErrorPage` and all the resources associated must be in the same folder.

#### Returned object

Expand Down

0 comments on commit df8363e

Please sign in to comment.