Federation Manager Async API 1.0.0

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

Contact link: API Support Contact email: help@incommon.org

Operations

Pub fmPerson

Accepts the following message:

fmPerson

Action taken on a Federation Manager person

person fedMgr

Describes a CRUD action on a person by the Federation Manager

Payload fmPerson

object

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmPerson

Payload

{
  "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
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Sub fmPerson

Accepts the following message:

fmPerson

Action taken on a Federation Manager person

person fedMgr

Describes a CRUD action on a person by the Federation Manager

Payload fmPerson

object

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmPerson

Payload

{
  "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
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Pub fmOrg

Accepts the following message:

fmOrg

Action taken on a Federation Manager organization

org fedMgr

Describes a CRUD action on an organization by the Federation Manager

Payload fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmOrg

Payload

{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "orgName": {
    "value": "string",
    "type": "legal"
  },
  "orgUrl": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Sub fmOrg

Accepts the following message:

fmOrg

Action taken on a Federation Manager organization

org fedMgr

Describes a CRUD action on an organization by the Federation Manager

Payload fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmOrg

Payload

{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "orgName": {
    "value": "string",
    "type": "legal"
  },
  "orgUrl": "string",
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Pub fmRole

Accepts the following message:

fmRole

Action taken on a Federation Manager role

role fedMgr

Describes a CRUD action on a role by the Federation Manager

Payload fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmRole

Payload

{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "roleName": {
    "value": "exec",
    "description": "string"
  },
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Sub fmRole

Accepts the following message:

fmRole

Action taken on a Federation Manager role

role fedMgr

Describes a CRUD action on a role by the Federation Manager

Payload fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmRole

Payload

{
  "resourceType": "string",
  "resourceTypeVersion": "string",
  "roleName": {
    "value": "exec",
    "description": "string"
  },
  "identifier": {
    "value": "string",
    "type": "fm-user-pk"
  }
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Pub fmAssignment

Accepts the following message:

fmAssignment

Action taken on a Federation Manager role assognment

assignment fedMgr

Describes a CRUD action on a role assignment by the Federation Manager

Payload fmAssignment

object

resourceType

string

resourceTypeVersion

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

role fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

org fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

person

array<object>

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional items are allowed.

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmAssignment

Payload

{
  "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
    }
  ]
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Sub fmAssignment

Accepts the following message:

fmAssignment

Action taken on a Federation Manager role assognment

assignment fedMgr

Describes a CRUD action on a role assignment by the Federation Manager

Payload fmAssignment

object

resourceType

string

resourceTypeVersion

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

role fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

org fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

person

array<object>

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional items are allowed.

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

Examples

fmAssignment

Payload

{
  "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
    }
  ]
}

This example has been generated automatically.

Headers

{
  "header": "string",
  "lastModified": "string",
  "schemas": "string",
  "eventType": "create"
}

This example has been generated automatically.

Messages

#1 fmPerson

Action taken on a Federation Manager person

person fedMgr

Describes a CRUD action on a person by the Federation Manager

Payload fmPerson

object

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

#2 fmOrg

Action taken on a Federation Manager organization

org fedMgr

Describes a CRUD action on an organization by the Federation Manager

Payload fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

#3 fmRole

Action taken on a Federation Manager role

role fedMgr

Describes a CRUD action on a role by the Federation Manager

Payload fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.

#4 fmAssignment

Action taken on a Federation Manager role assognment

assignment fedMgr

Describes a CRUD action on a role assignment by the Federation Manager

Payload fmAssignment

object

resourceType

string

resourceTypeVersion

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

role fmRole

object

resourceType

string

resourceTypeVersion

string

roleName roleName

object

value

string

Enum: "exec" "site-admin" "delegated-admin" "registration-authority-admin" "cert-rao"

description

string

Additional properties are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

org fmOrg

object

resourceType

string

resourceTypeVersion

string

orgName orgName

object

value

string

type

string

Enum: "legal" "display" "canonical"

Additional properties are allowed.

orgUrl url

string

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

person

array<object>

resourceType

string

resourceTypeVersion

string

name name

array<object>

family

string

given

string

middle

string

displayName

string

type

string

Additional items are allowed.

identifier identifier

object

value

string

type

string

Enum: "fm-user-pk" "fm-role-pk" "fm-org-pk" "fm-assignment-pk"

Additional properties are allowed.

email email

array<object>

same as emailAddress in Core Attribute Specification

address

string

type

string

verified

boolean

Additional items are allowed.

telephoneNumber telephoneNumber

array<object>

same as telephoneNumber in Core Attribute Specification

number

string

type

string

verified

boolean

Additional items are allowed.

fmIsIdentityProofed fmIsIdentityProofed

boolean

Additional items are allowed.

Additional properties are allowed.

Headers headers

object

header

string

lastModified

string

schemas

string

eventType

string

Enum: "create" "read" "update" "delete" "personadd" "personremove"

Additional properties are allowed.