ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-04 20:05:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing accepted credentials object snippet

Browse Source
This commit is contained in:
mDuo13
2025-07-14 13:59:42 -07:00
parent d6075dd033
commit 0b589610ae
3 changed files with 25 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/_snippets/accepted-credentials-objects.md Normal file
View File

@@ -0,0 +1,22 @@
Each member of the `AcceptedCredentials` array is an inner object named `Credential` with the following nested fields:
| Field | JSON Type | [Internal Type][] | Required? | Description |
|:-----------------|:---------------------|:------------------|:----------|--------------|
| `Issuer` | String - [Address][] | AccountID | Yes | The issuer of the credential. |
| `CredentialType` | String | Blob | Yes | The type of credential, as hexadecimal. This is an arbitrary value from 1 to 64 bytes that the issuer sets when they issue a credential. |
{% admonition type="info" name="Note" %}
In the usual JSON format, inner objects are wrapped in an object with one field, whose name defines the inner object type. In this case, the wrapping field is named `Credential`. For example:
```json
"AcceptedCredentials": [
{
"Credential": {
"Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"CredentialType": "6D795F63726564656E7469616C"
}
},
// ... additional Credential inner objects ...
]
```
{% /admonition %}

24
docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md
View File

@@ -52,31 +52,9 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `PreviousTxnLgrSeq` | Number | UInt32 | Yes | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. |
| `Sequence` | Number | UInt32 | Yes | The `Sequence` value of the transaction that created this entry. |
### AcceptedCredentials Objects
Each member of the `AcceptedCredentials` array is an inner object named `Credential` with the following nested fields:
| Field | JSON Type | [Internal Type][] | Required? | Description |
|:-----------------|:---------------------|:------------------|:----------|--------------|
| `Issuer` | String - [Address][] | AccountID | Yes | The issuer of the credential. |
| `CredentialType` | String | Blob | Yes | The type of credential, as hexadecimal. This is an arbitrary value from 1 to 64 bytes that the issuer sets when they issue a credential. |
{% admonition type="info" name="Note" %}
In the usual JSON format, inner objects are wrapped in an object with one field, whose name defines the inner object type. In this case, the wrapping field is named `Credential`. For example:
```json
"AcceptedCredentials": [
{
"Credential": {
"Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"CredentialType": "6D795F63726564656E7469616C"
}
},
// ... additional Credential inner objects ...
]
```
{% /admonition %}
{% raw-partial file="/docs/_snippets/accepted-credentials-objects.md" /%}
## {% $frontmatter.seo.title %} Flags

2
docs/references/protocol/transactions/types/permissioneddomainset.md
View File

@@ -40,6 +40,8 @@ _(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_
| `DomainID` | String - [Hash][] | Hash256 | No | The ledger entry ID of an existing permissioned domain to modify. If omitted, creates a new permissioned domain. |
| `AcceptedCredentials` | Array | Array | Yes | A list of 1 to 10 [**Accepted Credentials objects**](#accepted-credentials-objects) that grant access to this domain. The list does not need to be sorted, but it cannot contain duplicates. When modifying an existing domain, this list replaces the existing list. |
### AcceptedCredentials Objects
{% raw-partial file="/docs/_snippets/accepted-credentials-objects.md" /%}
## {% $frontmatter.seo.title %} Flags