You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/developers/api-reference/iam-policies-api/index.md
+3-24Lines changed: 3 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,12 @@ menu:
11
11
parent: "api-reference"
12
12
weight: 115
13
13
toc: true
14
-
aliases:
14
+
aliases:
15
15
- /docs/api-reference/iam-policies-api/
16
16
---
17
17
{{< note >}}
18
-
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
19
-
If you are looking for a simple way to test our API you might prefer our [Postman collection](https://www.postman.com/datatrails-inc/workspace/datatrails-public/overview), the [YAML runner](/developers/yaml-reference/story-runner-components/) or the [Developers](https://app.datatrails.ai) section of the web UI.
18
+
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
19
+
If you are looking for a simple way to test our API you might prefer our [Postman collection](https://www.postman.com/datatrails-inc/workspace/datatrails-public/overview), the [YAML runner](/developers/yaml-reference/story-runner-components/) or the [Developers](https://app.datatrails.ai) section of the web UI.
20
20
21
21
Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Copy file name to clipboardExpand all lines: content/developers/developer-patterns/getting-access-tokens-using-app-registrations/index.md
+8-9Lines changed: 8 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ date: 2021-06-16T11:12:25+01:00
6
6
lastmod: 2023-09-27T11:12:25+01:00
7
7
draft: false
8
8
images: []
9
-
menu:
9
+
menu:
10
10
developers:
11
11
parent: "developer-patterns"
12
12
weight: 31
@@ -17,7 +17,7 @@ aliases:
17
17
---
18
18
19
19
Non-interactive access to the DataTrails platform is managed by creating `Integrations` with either a Custom Integration or one of the built-in Integrations. This is done from the `Integrations` page in the DataTrails UI (reachable
20
-
from the `Settings` page or the `Integrations` shortcut in the sidebar.) You can also do this via
20
+
from the `Settings` page or the `Integrations` shortcut in the sidebar.) You can also do this via
21
21
the App Registrations REST API.
22
22
23
23
{{< note >}}
@@ -40,7 +40,7 @@ The high level steps are:
40
40
If you have already saved a `CLIENT_ID` and a `SECRET`, with the correct [permissions applied](#grant-permissions-to-custom-integration), skip to [Getting a Token With the Custom Integration](#getting-a-token-with-the-custom-integration)
If `Settings` or `Integrations` does not appear in the navigation, see your DataTrails Administrator for access.
45
45
{{< /note >}}
46
46
@@ -57,17 +57,17 @@ If `Settings` or `Integrations` does not appear in the navigation, see your Data
57
57
**Note:** Optionally add any `Custom claims` at this step by clicking the `+ Add` button.<br>In this context, claims are pieces of information that are asserted in a JSON Web Token (JWT). *Registered* claims are name/value pairs that are defined by the JWT standard, *Custom* claims are not defined and can have any name/value combination.
58
58
59
59
Ensure the `Name`*does not start* with `jit_` or `arc_` (DataTrails reserved names) or use any other well-known reserved claims.
60
-
60
+
61
61
See [here](https://auth0.com/docs/security/tokens/json-web-tokens/json-web-token-claims#reserved-claims) for more information on JWT Claims
62
-
{{< /note >}}
63
-
1. If this Custom Integration should have administrator privileges, assign it the `Owner` role by
62
+
{{< /note >}}
63
+
1. If this Custom Integration should have administrator privileges, assign it the `Owner` role by
64
64
checking that option. If you do this, ensure the client credentials are securely protected.
65
65
1. Once complete, click `Confirm` to complete the custom integration
66
66
1. You will then be presented with the `CLIENT_ID` and `SECRET` required by the archivist token endpoint
67
67
{{< img src="RecordClientIDandSecret.png" alt="Rectangle" caption="<em>Record your Client ID and Secret</em>" class="border-0" >}}
68
68
{{< caution >}}
69
69
**Caution:** Save the `CLIENT_ID` and `SECRET` to a password manager or secret management service as the `SECRET` can **not** be viewed again. A new `SECRET` can be regenerated in the Integration configuration screen but this replaces and invalidates the previous `SECRET`.
70
-
{{< /caution >}}
70
+
{{< /caution >}}
71
71
72
72
### Grant Access Permissions to your Custom Integration
73
73
@@ -133,7 +133,7 @@ Having completed the steps to create a [custom integration](./#creating-a-custom
Copy file name to clipboardExpand all lines: content/developers/yaml-reference/assets/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ aliases:
26
26
Adding an `asset_label` allows your Asset to be referenced in later steps of the story.
27
27
For example, when you want to add an Event to the Asset after it is created.
28
28
29
-
The `arc_namespace`(for the Asset) and the `namespace` (for the location) are used to distinguish between Assets and Locations created between runs of the story. Usually, these field values are derived from an environment variable `ARCHIVIST_NAMESPACE` (default value is namespace).
29
+
The `arc_namespace`is used to distinguish between Assets created between runs of the story. Usually, these field values are derived from an environment variable `ARCHIVIST_NAMESPACE` (default value is namespace).
30
30
31
31
The optional `confirm: true` entry means that the YAML Runner will wait for the Asset to be committed before moving on to the next step. This is beneficial if the Asset will be referenced in later steps.
Copy file name to clipboardExpand all lines: content/developers/yaml-reference/events/index.md
+2-15Lines changed: 2 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ aliases:
25
25
26
26
The `asset_label` must match the setting when the Asset was created in an earlier step. The `asset_label` may also be specified as the Asset ID of an existing Asset, in the form `assets/<asset-id>`.
27
27
28
-
There are a few optional settings that can be used when creating Events. `attachments` uploads the attachment to DataTrails and the response is added to the Event before posting. `location` creates the location if it does not exist and adds it to the Event. The `sbom` setting uploads the SBOM to DataTrails and adds the response to the Event before posting.
28
+
There are a few optional settings that can be used when creating Events. `attachments` uploads the attachment to DataTrails and the response is added to the Event before posting. The `sbom` setting uploads the SBOM to DataTrails and adds the response to the Event before posting.
29
29
30
30
`confirm: true` tells the YAML Runner to wait for the Event to be committed before moving to the next step.
31
31
This is optional and only necessary if your workflow requires 3rd parties (public or other DataTrails tenancies) to immediately view the Event.
@@ -49,26 +49,13 @@ steps:
49
49
arc_evidence: ARQC 0x12345678
50
50
wavestone_door_name: Courts of Justice Paris Front Door
51
51
wavestone_evt_type: door_open
52
-
location:
53
-
selector:
54
-
- display_name
55
-
- attributes:
56
-
- namespace
57
-
display_name: Paris Courts of Justice
58
-
description: Public museum in the former Palais de Justice
59
-
latitude: 48.855722
60
-
longitude: 2.345051
61
-
attributes:
62
-
namespace: door entry
63
-
address: 10 Boulevard du Palais, 75001 Paris, France
0 commit comments