min-reg-person/fmScratch.adoc at master · internet2/min-reg-person

Object type: FMperson (person)

Attributes:

resourceTypeVersion: { string literal: “1.1.0” }

resourceType: { string literal: “FMperson” }

schemas: { collection of schema references for the message format(s) }

eventType: {create, read, update, delete}

sorID: ? {COmanage user identifier (COmanage-generated ePPN- this will be null at first, then we will start flowing it into FM user models from COmanage. Need to add this as an attribute on FM user model/database now)} Format should be according to: https://github.internet2.edu/api-schema/person/blob/master/schema/minimalRegistryPerson.json and “source” should be “icp-comanage” for COmanage-sourced identifiers. The FM primary int32 user record key should also be included as a “source” of “fm-user-pk”

lastModified: ? { ISO 8601 date time stamp of object most recent modification }

email: ? { email address formatted according to https://github.internet2.edu/api-schema/person/blob/master/schema/minimalRegistryPerson.json} “emailType” should be “fm-user-email”

ePPN: ? { eduPersonPrincipalName/”username”}

name: ? { name element formatted according to https://github.internet2.edu/api-schema/person/blob/master/schema/minimalRegistryPerson.json, including all properties that exist for this person in the FM database }

phone: ? { phone number(s) formatted according to https://github.internet2.edu/api-schema/person/blob/master/schema/minimalRegistryPerson.json containing zero or more phoneNumber/phoneType elements }

fmIsIdentityProofed: ? {if LOA < 1, should be “false”; if LOA > 1, should be “true”} [bool]

Object type: FMrole (role)

Attributes:

resourceTypeVersion: { string literal: “1.1.0” }

resourceType: { string literal: “FMrole” }

schemas: { collection of schema references for the message format(s) }

lastModified: ? { ISO 8601 date time stamp of object most recent modification }

eventType: {create, read, update, delete, personadd, personremove }

sorID: ? { FM role primary key [int32] } Format should be according to: https://github.internet2.edu/api-schema/person/blob/master/schema/minimalRegistryPerson.json and “source” should be “fm-role-pk”

roleName: {Name of role: {exec, site-admin, delegated-admin, registration-authority-admin, cert-rao, etc.}

FMorg: {embedded FMorg object that this role applies to, see below. Action should be “read” in the embedded FMorg in this case} [FMorg]

FMperson: ? {If message action is personadd or personremove, this value MUST NOT be null, and this attribute should contain a collection of one or more embedded FMperson objects that the change applies to, see above. Action should be “read” in the embedded FMperson in this case} [FMperson]