Skip to content

Commit

Permalink
feat: integration example create attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
britsta committed Oct 20, 2023
1 parent f820de9 commit 24fcaa5
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions _includes/scenarios/integrate/integration-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,25 +34,14 @@ It in turn accepts the Request, which results in the creation of a new Relations

### Connector: Create an Attribute

In order to share an Attribute via a Relationship Template, we need to create one by executing `POST /api/v2/Attributes` with the following payload:

```json
{
"content": {
"@type": "IdentityAttribute",
"owner": "<your connector's Address>",
"value": {
"@type": "DisplayName",
"value": "Connector Tutorial"
}
}
}
```

You can query the Connector's Address under the route `/api/v2/Account/IdentityInfo`. If you are using the Demo Connector of this Tutorial, the Address is `id134nJmN7E4Carb6KyRJyePVnXxVHEYQgWD`.
{: .notice--info}
As an example, we want to create a display name for our Connector. While communicating with the other Identity in the subsequent steps, we will choose to share this display name with the other Identity. Technically, we therefore need to create an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) with an Identity Attribute Value of type [DisplayName]({% link _docs_integrate/attribute-values.md %}#displayname) for our Connector. To do this, proceed as described in the [Create own IdentityAttribute]({% link _docs_integrate/create-own-identityattribute.md %}) guide and use the table values

| Property of Identity Attribute Value | Input value |
| ------------------------------------ | ----------------------------------- |
| `@type` | `"DisplayName"` |
| `value` | `"<your Connector's display name>"` |

{% include rapidoc api_route_regex="^post /api/v2/Attributes$" %}
in the appropriate place.

{% include copy-notice description="Save the `id` of the Attribute that you can find in the response. You will need it in the next step." %}

Expand Down

0 comments on commit 24fcaa5

Please sign in to comment.