Skip to content
Permalink
47c5e62f09
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

fed-mgr-msg/asyncApiDoc.md

Go to file
 
 
Cannot retrieve contributors at this time
3753 lines (2846 sloc) 51.8 KB
Raw Blame
# Federation Manager Async API 1.0.0 documentation
Draft 04: Specification of the Async API for TAP-ICP Federation Manager
Messaging
## Table of Contents
* [Terms of Service](#termsOfService)
* [Servers](#servers)
* [Channels](#channels)
<a name="termsOfService"></a>
## Terms of service
[http://asyncapi.org/terms/](http://asyncapi.org/terms/)
<a name="servers"></a>
## Servers
<table>
<thead>
<tr>
<th>URL</th>
<th>Protocol</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>dev.fm.internet2.edu</td>
<td>amqp</td>
<td>Development server</td>
</tr>
<tr>
<td colspan="3">
<details>
<summary>URL Variables</summary>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default value</th>
<th>Possible values</th>
<th>Description</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
</details>
</td>
</tr>
<tr>
<td>staging.fm.internet2.edu</td>
<td>amqp</td>
<td>Staging server</td>
</tr>
<tr>
<td colspan="3">
<details>
<summary>URL Variables</summary>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default value</th>
<th>Possible values</th>
<th>Description</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
</details>
</td>
</tr>
<tr>
<td>api.fm.internet2.edu</td>
<td>amqp</td>
<td>Production server</td>
</tr>
<tr>
<td colspan="3">
<details>
<summary>URL Variables</summary>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default value</th>
<th>Possible values</th>
<th>Description</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
</details>
</td>
</tr>
</tbody>
</table>
## Channels
<a name="channel-fmPerson"></a>
#### Channel Parameters
### `publish` fmPerson
#### Message
Action taken on a Federation Manager person
Describes a CRUD action on a person by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* person
* fedMgr
### `subscribe` fmPerson
#### Message
Action taken on a Federation Manager person
Describes a CRUD action on a person by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* person
* fedMgr
<a name="channel-fmOrg"></a>
#### Channel Parameters
### `publish` fmOrg
#### Message
Action taken on a Federation Manager organization
Describes a CRUD action on an organization by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>orgName </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>orgName.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>orgName.type </td>
<td>string</td>
<td> </td>
<td><code>legal</code>, <code>display</code>, <code>canonical</code></td>
</tr>
<tr>
<td>orgUrl </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"orgName": {
"value": "string",
"type": "legal"
},
"orgUrl": "string",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* org
* fedMgr
### `subscribe` fmOrg
#### Message
Action taken on a Federation Manager organization
Describes a CRUD action on an organization by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>orgName </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>orgName.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>orgName.type </td>
<td>string</td>
<td> </td>
<td><code>legal</code>, <code>display</code>, <code>canonical</code></td>
</tr>
<tr>
<td>orgUrl </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"orgName": {
"value": "string",
"type": "legal"
},
"orgUrl": "string",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* org
* fedMgr
<a name="channel-fmRole"></a>
#### Channel Parameters
### `publish` fmRole
#### Message
Action taken on a Federation Manager role
Describes a CRUD action on a role by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>roleName </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"roleName": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* role
* fedMgr
### `subscribe` fmRole
#### Message
Action taken on a Federation Manager role
Describes a CRUD action on a role by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>roleName </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>roleName.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"roleName": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
```
##### Tags
* role
* fedMgr
<a name="channel-fmAssignment"></a>
#### Channel Parameters
### `publish` fmAssignment
#### Message
Action taken on a Federation Manager role assognment
Describes a CRUD action on a role assignment by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>role </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>role.roleName </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>role.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>org.orgName </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.orgName.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.orgName.type </td>
<td>string</td>
<td> </td>
<td><code>legal</code>, <code>display</code>, <code>canonical</code></td>
</tr>
<tr>
<td>org.orgUrl </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>org.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>person.name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>person.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"role": {
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"roleName": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
},
"org": {
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"orgName": {
"value": "string",
"type": "legal"
},
"orgUrl": "string",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
},
"person": [
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
]
}
```
##### Tags
* assignment
* fedMgr
### `subscribe` fmAssignment
#### Message
Action taken on a Federation Manager role assognment
Describes a CRUD action on a role assignment by the Federation Manager
##### Headers
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>header </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of headers _(generated)_
```json
{
"header": "string"
}
```
##### Payload
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Accepted values</th>
</tr>
</thead>
<tbody>
<tr>
<td>resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>role </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>role.roleName </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.roleName.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>role.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>role.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>org.orgName </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.orgName.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.orgName.type </td>
<td>string</td>
<td> </td>
<td><code>legal</code>, <code>display</code>, <code>canonical</code></td>
</tr>
<tr>
<td>org.orgUrl </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>org.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>org.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.resourceType </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.resourceTypeVersion </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.schemas </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.eventType </td>
<td>string</td>
<td> </td>
<td><code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, <code>personadd</code>, <code>personremove</code></td>
</tr>
<tr>
<td>person.name </td>
<td>array(object)</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.family </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.given </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.middle </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.displayName </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.name.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.lastModified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier </td>
<td>object</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier.value </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.identifier.type </td>
<td>string</td>
<td> </td>
<td><code>fm-user-pk</code>, <code>fm-role-pk</code>, <code>fm-org-pk</code>, <code>fm-assignment-pk</code></td>
</tr>
<tr>
<td>person.email </td>
<td>array(object)</td>
<td><p>same as emailAddress in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.address </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.email.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber </td>
<td>array(object)</td>
<td><p>same as telephoneNumber in Core Attribute Specification</p>
</td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.number </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.type </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.telephoneNumber.verified </td>
<td>string</td>
<td> </td>
<td><em>Any</em></td>
</tr>
<tr>
<td>person.fmIsIdentityProofed </td>
<td>boolean</td>
<td> </td>
<td><em>Any</em></td>
</tr></tbody>
</table>
###### Example of payload _(generated)_
```json
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"role": {
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"roleName": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
},
"org": {
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"orgName": {
"value": "string",
"type": "legal"
},
"orgUrl": "string",
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
},
"person": [
{
"resourceType": "string",
"resourceTypeVersion": "string",
"schemas": "string",
"eventType": "create",
"name": [
{
"family": "string",
"given": "string",
"middle": "string",
"displayName": "string",
"type": "string"
}
],
"lastModified": "string",
"identifier": {
"value": "string",
"type": "fm-user-pk"
},
"email": [
{
"address": "string",
"type": "string",
"verified": "string"
}
],
"telephoneNumber": [
{
"number": "string",
"type": "string",
"verified": "string"
}
],
"fmIsIdentityProofed": true
}
]
}
```
##### Tags
* assignment
* fedMgr