Skip to content

Commit 1e35fcc

Browse files
committed
DOC-3143: add partial file for expected data structure for auth token.
1 parent 2615a43 commit 1e35fcc

File tree

4 files changed

+25
-3
lines changed

4 files changed

+25
-3
lines changed

modules/ROOT/pages/exportpdf.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For more infomation on the exportpdf_token_provider option, see xref:exportpdf.a
4949
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
5050
5151
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
52-
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
52+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a xref:importword.adoc#data-structure[valid JSON object] containing the token.
5353
5454
For more information on how to set up JWT authentication with {pluginname}, see examples:
5555
@@ -64,6 +64,8 @@ For more information on how to set up JWT authentication with {pluginname}, see
6464
* Attempting to use JWT authentication during the trial will result in an _error_.
6565
====
6666

67+
include::partial$misc/admon-document-converters-jwt-expected-data-structure.adoc[]
68+
6769
== Basic setup using the self-hosted service
6870

6971
To use the self-hosted version of the {pluginname} plugin, you need to set the `exportpdf_service_url` option to the URL of the service.

modules/ROOT/pages/exportword.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ For more infomation on the exportword_token_provider option, see xref:exportword
5555
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
5656
5757
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
58-
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
58+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a xref:exportword.adoc#data-structure[valid JSON object] containing the token.
5959
6060
For more information on how to set up JWT authentication with {pluginname}, see examples:
6161
@@ -70,6 +70,8 @@ For more information on how to set up JWT authentication with {pluginname}, see
7070
* Attempting to use JWT authentication during the trial will result in an _error_.
7171
====
7272

73+
include::partial$misc/admon-document-converters-jwt-expected-data-structure.adoc[]
74+
7375

7476

7577

modules/ROOT/pages/importword.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ For more infomation on the importword_token_provider option, see xref:importword
5050
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
5151
5252
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
53-
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
53+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a xref:importword.adoc#data-structure[valid JSON object] containing the token.
5454
5555
For more information on how to set up JWT authentication with {pluginname}, see examples:
5656
@@ -65,6 +65,8 @@ For more information on how to set up JWT authentication with {pluginname}, see
6565
* Attempting to use JWT authentication during the trial will result in an _error_.
6666
====
6767

68+
include::partial$misc/admon-document-converters-jwt-expected-data-structure.adoc[]
69+
6870
== Basic setup using the self-hosted service
6971

7072
To use the self-hosted version of the {pluginname} plugin, you need to set the `importword_service_url` option to the URL of the service.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
== Data structure
2+
3+
The JSON data containing the valid encoded token must match the following structure:
4+
5+
[source,json]
6+
----
7+
{
8+
"token": "<encoded JWT string>"
9+
}
10+
----
11+
12+
[cols="1,1,1,3",options="header"]
13+
|===
14+
|Field |Type |Required? |Description
15+
|`+token+` |`+string+` |required |A Base64-encoded JSON Web Token (JWT) used for authentication and authorization.
16+
|===

0 commit comments

Comments
 (0)