View Source

Attributes

Version: 1.0
Defined types are as configured at a platform (when attached to an Org Identity) or CO (when attached to a CO Person or CO Department) level. CO-specific types can be determined via the CoExtendedType API.
See cm_identifiers for definitions of other attributes and elements

JSON Request

{
  "RequestType":"Identifiers",
  "Version":"1.0",
  "Identifiers":
  [
    {
      "Version":"1.0",
      "Type":"<Type>",
      "Identifier":"<Identifier>",
      "Login":true|false,
      "Person":{"Type":("CO"|"Dept"|"Group"|"Org"|"Organization"),"Id":"<ID>"},
      "CoProvisioningTargetId":"<CoProvisioningTargetId>",
      "Status":"Active"|"Deleted"
    }
  ]
}

JSON Request (Assignment)

{
  "RequestType":"Identifiers",
  "Version":"1.0",
  "Identifiers":
  [
    {
      "Version":"1.0",
      "Person":{"Type":("CO"|"Dept"|"Group"),"Id":"<ID>"}
    }
  ]
}

XML Request

<!ELEMENT Identifiers (Identifier)>
 <!ATTLIST Identifiers Version CDATA #FIXED "1.0">
 <!ELEMENT Identifier (Type,Identifier,Login,Person)>
  <!ATTLIST Identifier Version CDATA #FIXED "1.0">
  <!ELEMENT Type (#PCDATA)>
  <!ELEMENT Identifier (#PCDATA)>
  <!ELEMENT Login (True|False)>
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Person Type (CO|Dept|Group|Org|Organization)>
   <!ELEMENT Person Id ID>
  <!ELEMENT CoProvisioningTargetId (#PCDATA)>
  <!ELEMENT Status (Active|Deleted)>

XML Request (Assignment)

<!ELEMENT Identifiers (Identifier)>
 <!ATTLIST Identifiers Version CDATA #FIXED "1.0">
 <!ELEMENT Identifier (Person)>
  <!ATTLIST Identifier Version CDATA #FIXED "1.0">
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Person Type (CO|Dept|Group)>
   <!ELEMENT Person Id ID>

JSON Response

{
  "ResponseType":"Identifiers",
  "Version":"1.0",
  "Identifiers":
  [
    {
      "Version":"1.0",
      "Id":"<ID>",
      "Type":"<Type>",
      "Identifier":"<Identifier>",
      "Login":true|false,
      "Person":{"Type":("CO"|"Dept"|"Group"|"Org"|"Organization"),"ID":"<ID>"},
      "CoProvisioningTargetId":"<CoProvisioningTargetId>",
      "Status":"Active"|"Deleted",
      "Created":"<CreateTime>",
      "Modified":"<ModTime>"
    },
    {...}
  ]
}

XML Response

<!ELEMENT Identifiers (Identifier+)>
 <!ATTLIST Identifiers Version CDATA #FIXED "1.0">
 <!ELEMENT Identifier (Type,Identifier,Login,Person)>
  <!ATTLIST Identifier Version CDATA #FIXED "1.0">
  <!ATTLIST Identifier Id ID>
  <!ELEMENT Type (#PCDATA)>
  <!ELEMENT Identifier (#PCDATA)>
  <!ELEMENT Login (True|False)>
  <!ELEMENT Person (Type,Id)>
   <!ELEMENT Person Type (CO|Dept|Group|Org|Organization)>
   <!ELEMENT Person Id ID>
  <!ELEMENT CoProvisioningTargetId (#PCDATA)>
  <!ELEMENT Status (Active|Deleted)>
  <!ELEMENT Created (#PCDATA)>
  <!ELEMENT Modified (#PCDATA)>