Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Advanced concepts update #786

Closed
wants to merge 21 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
81f64d7
Bump hugo-bin from 0.119.0 to 0.120.0
dependabot[bot] Feb 20, 2024
cc5b66f
Merge pull request #772 from datatrails/dependabot/npm_and_yarn/hugo-…
kjc-datatrails Feb 20, 2024
b72e885
Bump hugo-bin from 0.120.0 to 0.120.1
dependabot[bot] Feb 21, 2024
f3a260b
Bump bootstrap from 5.3.2 to 5.3.3
dependabot[bot] Feb 21, 2024
faa0c70
Merge pull request #773 from datatrails/dependabot/npm_and_yarn/hugo-…
kjc-datatrails Feb 21, 2024
ca1c846
Merge pull request #774 from datatrails/dependabot/npm_and_yarn/boots…
kjc-datatrails Feb 21, 2024
ca5ebf3
Add python pre-req and quotes for mac curl
SteveLasker Feb 23, 2024
a9e6c62
Bump eslint from 8.56.0 to 8.57.0
dependabot[bot] Feb 26, 2024
41e5957
Bump hugo-bin from 0.120.1 to 0.120.4
dependabot[bot] Feb 27, 2024
e817a89
Bump @babel/core from 7.23.9 to 7.24.0
dependabot[bot] Feb 28, 2024
d4867d2
Bump @babel/preset-env from 7.23.9 to 7.24.0
dependabot[bot] Feb 28, 2024
b9d4a1a
Merge pull request #778 from datatrails/dependabot/npm_and_yarn/eslin…
kjc-datatrails Feb 28, 2024
5b550a0
Merge pull request #779 from datatrails/dependabot/npm_and_yarn/hugo-…
kjc-datatrails Feb 28, 2024
33cd556
Merge pull request #780 from datatrails/dependabot/npm_and_yarn/babel…
kjc-datatrails Feb 28, 2024
57a0b60
Merge pull request #781 from datatrails/dependabot/npm_and_yarn/babel…
kjc-datatrails Feb 28, 2024
30c1300
Merge pull request #776 from datatrails/steve/scitt-mac-updates
SteveLasker Feb 28, 2024
1734e7c
API Reference updates (#782)
pcnorth Mar 1, 2024
d020d57
Bump autoprefixer from 10.4.17 to 10.4.18
dependabot[bot] Mar 4, 2024
b872647
Bump hugo-bin from 0.120.4 to 0.120.7
dependabot[bot] Mar 4, 2024
2e3c22d
Merge pull request #784 from datatrails/dependabot/npm_and_yarn/autop…
kjc-datatrails Mar 4, 2024
c7f3080
Merge pull request #785 from datatrails/dependabot/npm_and_yarn/hugo-…
kjc-datatrails Mar 4, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions content/developers/api-reference/app-registrations-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/app-registrations-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -25,6 +25,10 @@ Additional YAML examples can be found in the articles in the [Overview](/platfor

The App Registrations API enables you to create and manage application identities with access to your DataTrails Tenancy.

{{< note >}}
**Note:** App Registrations are called Custom Integrations in the DataTrail application UI.
{{< /note >}}

It supports the OpenID Connect Client Credentials Flow, which means that for each application you register, a `CLIENT_ID` and `SECRET` are generated and returned.

These credentials are then used to request an access token from `https://app.datatrails.ai/archivist/iam/v1/appidp/token`, which is used for API authentication to DataTrails.
Expand All @@ -33,10 +37,10 @@ Each App Registration is created with Non-Administrator privileges by default.

To provide your credentials with access to the Assets and Events in your Tenancy, it is best practice to create an [ABAC policy](../iam-policies-api/) with specific, declared permissions.

If you wish to give your credentials Administrator privileges to access everything in your Tenancy, you would use the `client-id` as the subject and `https://app.datatrails.ai/appidpv1` as the issuer in the `Settings` screen or by using the [Administrators Endpoint in the Tenancies API](../tenancies-api/).
If you wish to give your credentials Administrator privileges to access everything in your Tenancy, you would use the `client-id` as the subject and `https://app.datatrails.ai/appidpv1` as the issuer in the `Settings` screen or by using the [Administrators Endpoint in the Tenancies API](../tenancies-api/).<br>This would be necessary if you want to carry out Tenancy administration via the API.

{{< note >}}
For more information on App Registrations and access tokens, visit [DataTrails Developer Patterns](/developers/developer-patterns/getting-access-tokens-using-app-registrations/).
**Note:** For more information on App Registrations and access tokens, visit [DataTrails Developer Patterns](/developers/developer-patterns/getting-access-tokens-using-app-registrations/).
{{< /note >}}

### Creating an Application
Expand Down
7 changes: 5 additions & 2 deletions content/developers/api-reference/assets-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ aliases:
- /docs/api-reference/assets-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
{{< /note >}}
{{< note >}}
For more information on Assets and Asset creation, visit our [Core Concepts](/platform/overview/core-concepts/#assets) and [Creating an Asset](/platform/overview/creating-an-asset/) guide.
**Note:** For more information on Assets and Asset creation, visit our [Core Concepts](/platform/overview/core-concepts/#assets) and [Creating an Asset](/platform/overview/creating-an-asset/) guide.
{{< /note >}}

## Asset API Examples
Expand Down Expand Up @@ -53,6 +53,9 @@ Define the asset parameters and store in `/path/to/jsonfile`:
"public": false
}
```
{{< note >}}
**Note:** The values for `arc_blob_hash_value` and `arc_blob_identity` are taken from the response of the Upload call of the [Blob API](https://docs.datatrails.ai/developers/api-reference/blobs-api/).
{{< /note >}}

Create the Asset:

Expand Down
2 changes: 1 addition & 1 deletion content/developers/api-reference/attachments-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/attachments-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.io) section of the web UI.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand Down
5 changes: 3 additions & 2 deletions content/developers/api-reference/blobs-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/blobs-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -25,7 +25,8 @@ Additional YAML examples can be found in the articles in the [Overview](/platfor
The Blobs API enables you to upload Binary Large OBjects (BLOBs) such as documents, process artifacts and images to attach to your evidence ledger.

{{< note >}}
**Note:** Blobs cannot be searched or listed as a collection in their own right: they must always be associated with an Asset or Event through an Attachment Attribute and can only be downloaded by users with appropriate access rights to that Attachment. For information on Attachments and how to implement them, please refer to [the Events API Reference](../events-api/#adding-attachments).
**Note:** Blobs cannot be searched or listed as a collection in their own right: they must always be associated with an Asset or Event through an Attachment Attribute and can only be downloaded by users with appropriate access rights to that Attachment. Take note of the Blob ID returned in the API response, it will be needed for use with Assets and Events.<br>
For information on Attachments and how to implement them, please refer to [the Events API Reference](../events-api/#adding-attachments).
{{< /note >}}

Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.
Expand Down
8 changes: 4 additions & 4 deletions content/developers/api-reference/blockchain-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/blockchain-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.io) section of the web UI.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -29,15 +29,15 @@ Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-u
Blockchain transactions can be fetched from the blockchain endpoint using the Asset's Event ID as a parameter:

```bash
assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000
assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

To fetch all transactions for an Asset's Events GET the blockchain resource:

```bash
curl -v -X GET \
-H "@$HOME/.datatrails/bearer-token.txt" \
https://app.datatrails.ai/archivist/v1alpha2/blockchain/assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b3
https://app.datatrails.ai/archivist/v1alpha2/blockchain/assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/events/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

Depending on the type of [proof mechanism](/platform/overview/advanced-concepts/#proof-mechanisms) used, the response will be:
Expand Down Expand Up @@ -80,7 +80,7 @@ Depending on the type of [proof mechanism](/platform/overview/advanced-concepts/
```

{{< note >}}
Check out our guide for [Verifying Assets and Events with Simple Hash](/developers/developer-patterns/verifying-with-simple-hash/).
**Note:** Please see our guide for [Verifying Assets and Events with Simple Hash](/developers/developer-patterns/verifying-with-simple-hash/).
{{< /note >}}

## Blockchain OpenAPI Docs
Expand Down
2 changes: 1 addition & 1 deletion content/developers/api-reference/compliance-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/compliance-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand Down
2 changes: 1 addition & 1 deletion content/developers/api-reference/events-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/events-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand Down
8 changes: 5 additions & 3 deletions content/developers/api-reference/iam-policies-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/iam-policies-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand Down Expand Up @@ -43,7 +43,7 @@ This will return a `subjects/<UUID>` object you would then specify with the `sub
As both ABAC and OBAC use the same filter syntax, it is possible to have a mix of internal and external sharing within a single policy.

{{< note >}}
Learn more about [ABAC](/platform/administration/sharing-access-inside-your-tenant/) and [OBAC](/platform/administration/sharing-access-outside-your-tenant/) policies in our DataTrails Basics guides.
**Note:** Learn more about [ABAC](/platform/administration/sharing-access-inside-your-tenant/) and [OBAC](/platform/administration/sharing-access-outside-your-tenant/) policies in our DataTrails Basics guides.
{{< /note >}}

### IAM Policy Creation
Expand Down Expand Up @@ -138,7 +138,9 @@ The response is:
]
}
```

{{< note >}}
**Note:** Access polices are applied to the Asset. This means that when a policy is created or updated an Event will be recorded in the audit trail of matching Assets from the Actor `Archivist Internal`.
{{< /note >}}
### IAM Policy Retrieval

IAM Access Policy records in DataTrails are tokenized at creation time and referred to in all API calls and smart contracts throughout the system by a unique identity of the form:
Expand Down
5 changes: 4 additions & 1 deletion content/developers/api-reference/iam-subjects-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/iam-subjects-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -35,6 +35,9 @@ Define the Subject parameters and store in `/path/to/jsonfile`:
"tessera_pub_key": ["key2"]
}
```
{{< note >}}
**Note:** The values for `wallet_pub_key` and `tessera_pub_key` are found by decoding the Subject string that is provided by the Tenancy Administrator of the other organization. See the JSON tab [here](https://docs.datatrails.ai/platform/administration/sharing-access-outside-your-tenant/) for more detail.
{{< /note >}}

Create the IAM Subject:

Expand Down
4 changes: 2 additions & 2 deletions content/developers/api-reference/invites-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/invites-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -33,7 +33,7 @@ For sharing Assets and Events to other organizations and tenancies externally, c
Create the [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) and store in a file in a secure local directory with 0600 permissions.

{{< note >}}
See [here](/platform/administration/identity-and-access-management/#how-do-i-add-users-to-my-organization) for additional instructions on inviting users to your Tenancy.
**Note:** See [here](/platform/administration/identity-and-access-management/#how-do-i-add-users-to-my-organization) for additional instructions on inviting users to your Tenancy.
{{< /note >}}

### Invite Creation
Expand Down
4 changes: 2 additions & 2 deletions content/developers/api-reference/locations-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ aliases:
- /docs/api-reference/locations-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
{{< /note >}}
{{< note >}}
See [DataTrails Administration](/platform/administration/grouping-assets-by-location/) for additional information on creating and using locations with DataTrails.
**Note:** See [DataTrails Administration](/platform/administration/grouping-assets-by-location/) for additional information on creating and using locations with DataTrails.
{{< /note >}}

## Locations API Examples
Expand Down
10 changes: 5 additions & 5 deletions content/developers/api-reference/public-assets-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/public-assets-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand All @@ -31,13 +31,13 @@ Each Public Asset has a private and a public interface. The private interface is
The methods described below cover interacting with the public interface only. To interact with the private interface, use the standard [Assets API](../assets-api/).

{{< note >}}
Visit the [Public Attestation](/platform/overview/public-attestation/) guide for more information.
**Note:** Visit the [Public Attestation](/platform/overview/public-attestation/) guide for more information.
{{< /note >}}

### Fetch a Public Asset Record

```bash
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4
```

```json
Expand Down Expand Up @@ -66,7 +66,7 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/pub
### Fetch All Of a Public Asset's Events Records

```bash
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4/events
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4/events
```

```json
Expand Down Expand Up @@ -168,7 +168,7 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/pub
### Fetch a Public Asset's Specific Event Record

```bash
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4/events/7da272ad-19d5-4106-b4af-2980a84c2721
curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/publicassets/86b61c4b-030e-4c07-9400-463612e6cee4/events/7da272ad-19d5-4106-b4af-2980a84c2721
```

```json
Expand Down
2 changes: 1 addition & 1 deletion content/developers/api-reference/system-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ aliases:
- /docs/api-reference/system-api/
---
{{< note >}}
This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
**Note:** This page is primarily intended for developers who will be writing applications that will use DataTrails for provenance.
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.

Additional YAML examples can be found in the articles in the [Overview](/platform/overview/introduction/) section.
Expand Down
Loading
Loading