Skip to content
Permalink
master
Go to file
 
 
Cannot retrieve contributors at this time
3753 lines (2846 sloc) 51.8 KB

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

http://asyncapi.org/terms/

Servers

URL Protocol Description
dev.fm.internet2.edu amqp Development server
URL Variables
Name Default value Possible values Description
staging.fm.internet2.edu amqp Staging server
URL Variables
Name Default value Possible values Description
api.fm.internet2.edu amqp Production server
URL Variables
Name Default value Possible values Description

Channels

Channel Parameters

publish fmPerson

Message

Action taken on a Federation Manager person

Describes a CRUD action on a person by the Federation Manager

Headers
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
name array(object) Any
name.family string Any
name.given string Any
name.middle string Any
name.displayName string Any
name.type string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
name array(object) Any
name.family string Any
name.given string Any
name.middle string Any
name.displayName string Any
name.type string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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

Channel Parameters

publish fmOrg

Message

Action taken on a Federation Manager organization

Describes a CRUD action on an organization by the Federation Manager

Headers
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
orgName object Any
orgName.value string Any
orgName.type string legal, display, canonical
orgUrl string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
name array(object) Any
name.family string Any
name.given string Any
name.middle string Any
name.displayName string Any
name.type string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
orgName object Any
orgName.value string Any
orgName.type string legal, display, canonical
orgUrl string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
name array(object) Any
name.family string Any
name.given string Any
name.middle string Any
name.displayName string Any
name.type string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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

Channel Parameters

publish fmRole

Message

Action taken on a Federation Manager role

Describes a CRUD action on a role by the Federation Manager

Headers
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
roleName array(object) Any
roleName.family string Any
roleName.given string Any
roleName.middle string Any
roleName.displayName string Any
roleName.type string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
roleName array(object) Any
roleName.family string Any
roleName.given string Any
roleName.middle string Any
roleName.displayName string Any
roleName.type string Any
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
email array(object)

same as emailAddress in Core Attribute Specification

Any
email.address string Any
email.type string Any
email.verified string Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified string Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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

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
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
role object Any
role.resourceType string Any
role.resourceTypeVersion string Any
role.schemas string Any
role.eventType string create, read, update, delete, personadd, personremove
role.roleName array(object) Any
role.roleName.family string Any
role.roleName.given string Any
role.roleName.middle string Any
role.roleName.displayName string Any
role.roleName.type string Any
role.lastModified string Any
role.identifier object Any
role.identifier.value string Any
role.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
role.email array(object)

same as emailAddress in Core Attribute Specification

Any
role.email.address string Any
role.email.type string Any
role.email.verified string Any
role.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
role.telephoneNumber.number string Any
role.telephoneNumber.type string Any
role.telephoneNumber.verified string Any
role.fmIsIdentityProofed boolean Any
org object Any
org.resourceType string Any
org.resourceTypeVersion string Any
org.schemas string Any
org.eventType string create, read, update, delete, personadd, personremove
org.orgName object Any
org.orgName.value string Any
org.orgName.type string legal, display, canonical
org.orgUrl string Any
org.lastModified string Any
org.identifier object Any
org.identifier.value string Any
org.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
org.email array(object)

same as emailAddress in Core Attribute Specification

Any
org.email.address string Any
org.email.type string Any
org.email.verified string Any
org.name array(object) Any
org.name.family string Any
org.name.given string Any
org.name.middle string Any
org.name.displayName string Any
org.name.type string Any
org.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
org.telephoneNumber.number string Any
org.telephoneNumber.type string Any
org.telephoneNumber.verified string Any
org.fmIsIdentityProofed boolean Any
person array(object) Any
person.resourceType string Any
person.resourceTypeVersion string Any
person.schemas string Any
person.eventType string create, read, update, delete, personadd, personremove
person.name array(object) Any
person.name.family string Any
person.name.given string Any
person.name.middle string Any
person.name.displayName string Any
person.name.type string Any
person.lastModified string Any
person.identifier object Any
person.identifier.value string Any
person.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
person.email array(object)

same as emailAddress in Core Attribute Specification

Any
person.email.address string Any
person.email.type string Any
person.email.verified string Any
person.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
person.telephoneNumber.number string Any
person.telephoneNumber.type string Any
person.telephoneNumber.verified string Any
person.fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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
Name Type Description Accepted values
header string Any
Example of headers (generated)
{
  "header": "string"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
lastModified string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
role object Any
role.resourceType string Any
role.resourceTypeVersion string Any
role.schemas string Any
role.eventType string create, read, update, delete, personadd, personremove
role.roleName array(object) Any
role.roleName.family string Any
role.roleName.given string Any
role.roleName.middle string Any
role.roleName.displayName string Any
role.roleName.type string Any
role.lastModified string Any
role.identifier object Any
role.identifier.value string Any
role.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
role.email array(object)

same as emailAddress in Core Attribute Specification

Any
role.email.address string Any
role.email.type string Any
role.email.verified string Any
role.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
role.telephoneNumber.number string Any
role.telephoneNumber.type string Any
role.telephoneNumber.verified string Any
role.fmIsIdentityProofed boolean Any
org object Any
org.resourceType string Any
org.resourceTypeVersion string Any
org.schemas string Any
org.eventType string create, read, update, delete, personadd, personremove
org.orgName object Any
org.orgName.value string Any
org.orgName.type string legal, display, canonical
org.orgUrl string Any
org.lastModified string Any
org.identifier object Any
org.identifier.value string Any
org.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
org.email array(object)

same as emailAddress in Core Attribute Specification

Any
org.email.address string Any
org.email.type string Any
org.email.verified string Any
org.name array(object) Any
org.name.family string Any
org.name.given string Any
org.name.middle string Any
org.name.displayName string Any
org.name.type string Any
org.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
org.telephoneNumber.number string Any
org.telephoneNumber.type string Any
org.telephoneNumber.verified string Any
org.fmIsIdentityProofed boolean Any
person array(object) Any
person.resourceType string Any
person.resourceTypeVersion string Any
person.schemas string Any
person.eventType string create, read, update, delete, personadd, personremove
person.name array(object) Any
person.name.family string Any
person.name.given string Any
person.name.middle string Any
person.name.displayName string Any
person.name.type string Any
person.lastModified string Any
person.identifier object Any
person.identifier.value string Any
person.identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
person.email array(object)

same as emailAddress in Core Attribute Specification

Any
person.email.address string Any
person.email.type string Any
person.email.verified string Any
person.telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

Any
person.telephoneNumber.number string Any
person.telephoneNumber.type string Any
person.telephoneNumber.verified string Any
person.fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "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

You can’t perform that action at this time.