Skip to content
Permalink
master
Go to file
 
 
Cannot retrieve contributors at this time
2537 lines (1879 sloc) 34.8 KB

Federation Manager Async API 1.0.0 documentation

Draft 07: Specification of the Async API for TAP-ICP Federation Manager Messaging

Table of Contents

Terms of service

https://fm.incommon.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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion 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
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 boolean Any
telephoneNumber array(object)

same as telephoneNumber in Core Attribute Specification

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

same as telephoneNumber in Core Attribute Specification

Any
telephoneNumber.number string Any
telephoneNumber.type string Any
telephoneNumber.verified boolean Any
fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "name": [
    {
      "family": "string",
      "given": "string",
      "middle": "string",
      "displayName": "string",
      "type": "string"
    }
  ],
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  },
  "email": [
    {
      "address": "string",
      "type": "string",
      "verified": true
    }
  ],
  "telephoneNumber": [
    {
      "number": "string",
      "type": "string",
      "verified": true
    }
  ],
  "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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
orgName object Any
orgName.value string Any
orgName.type string legal, display, canonical
orgUrl string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "orgName": {
    "value": "string",
    "type": "legal"
  },
  "orgUrl": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}
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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
orgName object Any
orgName.value string Any
orgName.type string legal, display, canonical
orgUrl string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "orgName": {
    "value": "string",
    "type": "legal"
  },
  "orgUrl": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}
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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
roleName object Any
roleName.value string exec, site-admin, delegated-admin, registration-authority-admin, cert-rao
roleName.description string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "roleName": {
    "value": "exec",
    "description": "string"
  },
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}
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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion string Any
roleName object Any
roleName.value string exec, site-admin, delegated-admin, registration-authority-admin, cert-rao
roleName.description string Any
identifier object Any
identifier.value string Any
identifier.type string fm-user-pk, fm-role-pk, fm-org-pk, fm-assignment-pk
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "roleName": {
    "value": "exec",
    "description": "string"
  },
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}
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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion 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.roleName object Any
role.roleName.value string exec, site-admin, delegated-admin, registration-authority-admin, cert-rao
role.roleName.description 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
org object Any
org.resourceType string Any
org.resourceTypeVersion string Any
org.orgName object Any
org.orgName.value string Any
org.orgName.type string legal, display, canonical
org.orgUrl 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
person array(object) Any
person.resourceType string Any
person.resourceTypeVersion string Any
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.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 boolean 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 boolean Any
person.fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  },
  "role": {
    "resourceType": "string",
    "resourceTypeVersion": "string",
    "roleName": {
      "value": "exec",
      "description": "string"
    },
    "identifier": {
      "value": "string",
      "type": "fm-user-pk"
    }
  },
  "org": {
    "resourceType": "string",
    "resourceTypeVersion": "string",
    "orgName": {
      "value": "string",
      "type": "legal"
    },
    "orgUrl": "string",
    "identifier": {
      "value": "string",
      "type": "fm-user-pk"
    }
  },
  "person": [
    {
      "resourceType": "string",
      "resourceTypeVersion": "string",
      "name": [
        {
          "family": "string",
          "given": "string",
          "middle": "string",
          "displayName": "string",
          "type": "string"
        }
      ],
      "identifier": {
        "value": "string",
        "type": "fm-user-pk"
      },
      "email": [
        {
          "address": "string",
          "type": "string",
          "verified": true
        }
      ],
      "telephoneNumber": [
        {
          "number": "string",
          "type": "string",
          "verified": true
        }
      ],
      "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
lastModified string Any
schemas string Any
eventType string create, read, update, delete, personadd, personremove
Example of headers (generated)
{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}
Payload
Name Type Description Accepted values
resourceType string Any
resourceTypeVersion 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.roleName object Any
role.roleName.value string exec, site-admin, delegated-admin, registration-authority-admin, cert-rao
role.roleName.description 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
org object Any
org.resourceType string Any
org.resourceTypeVersion string Any
org.orgName object Any
org.orgName.value string Any
org.orgName.type string legal, display, canonical
org.orgUrl 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
person array(object) Any
person.resourceType string Any
person.resourceTypeVersion string Any
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.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 boolean 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 boolean Any
person.fmIsIdentityProofed boolean Any
Example of payload (generated)
{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  },
  "role": {
    "resourceType": "string",
    "resourceTypeVersion": "string",
    "roleName": {
      "value": "exec",
      "description": "string"
    },
    "identifier": {
      "value": "string",
      "type": "fm-user-pk"
    }
  },
  "org": {
    "resourceType": "string",
    "resourceTypeVersion": "string",
    "orgName": {
      "value": "string",
      "type": "legal"
    },
    "orgUrl": "string",
    "identifier": {
      "value": "string",
      "type": "fm-user-pk"
    }
  },
  "person": [
    {
      "resourceType": "string",
      "resourceTypeVersion": "string",
      "name": [
        {
          "family": "string",
          "given": "string",
          "middle": "string",
          "displayName": "string",
          "type": "string"
        }
      ],
      "identifier": {
        "value": "string",
        "type": "fm-user-pk"
      },
      "email": [
        {
          "address": "string",
          "type": "string",
          "verified": true
        }
      ],
      "telephoneNumber": [
        {
          "number": "string",
          "type": "string",
          "verified": true
        }
      ],
      "fmIsIdentityProofed": true
    }
  ]
}
Tags
  • assignment

  • fedMgr

You can’t perform that action at this time.