SCIM and vCard mapping
draft-greevenbosch-scim-vcard-mapping-00
The information below is for an old version of the document.
| Document | Type |
This is an older version of an Internet-Draft whose latest revision state is "Expired".
|
|
|---|---|---|---|
| Author | Bert Greevenbosch | ||
| Last updated | 2012-09-13 | ||
| RFC stream | (None) | ||
| Formats | |||
| Stream | Stream state | (No stream defined) | |
| Consensus boilerplate | Unknown | ||
| RFC Editor Note | (None) | ||
| IESG | IESG state | I-D Exists | |
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-greevenbosch-scim-vcard-mapping-00
scim B. Greevenbosch
Internet-Draft Huawei Technologies
Intended status: Standards Track September 13, 2012
Expires: March 17, 2013
SCIM and vCard mapping
draft-greevenbosch-scim-vcard-mapping-00
Abstract
This document defines a mapping between Simple Cloud Identity
Management (SCIM) and vCard. It can be used for conversion between
the different schemes, or as guidance to select one of them.
Greevenbosch Expires March 17, 2013 [Page 1]
Internet-Draft SCIM/vCard mapping September 2012
Note
Discussion and suggestions for improvement are requested, and should
be sent to scim@ietf.org.
Status of this Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 17, 2013.
Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Greevenbosch Expires March 17, 2013 [Page 2]
Internet-Draft SCIM/vCard mapping September 2012
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Requirements notation . . . . . . . . . . . . . . . . . . . . 5
3. Mapping from SCIM attributes to vCard properties . . . . . . . 6
4. Mapping from vCard properties to SCIM attributes . . . . . . . 11
5. Open issues . . . . . . . . . . . . . . . . . . . . . . . . . 16
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17
7. Security Considerations . . . . . . . . . . . . . . . . . . . 18
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 19
9. Normative References . . . . . . . . . . . . . . . . . . . . . 20
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 21
Greevenbosch Expires March 17, 2013 [Page 3]
Internet-Draft SCIM/vCard mapping September 2012
1. Introduction
The Simple Cloud Identity Management (SCIM) core schema
[I-D.scim-core-schema] defines a platform neutral data and extension
model for representing users of cloud services. SCIM core also
defines XML and JSON serialisations of the abstract schema.
This document defines a mapping between SCIM and vCard [RFC6350].
The mapping may serve several purposes:
o To provide a unified conversion mechanism between SCIM and vCard.
o To identify properties that are defined in vCard, but are missing
in SCIM.
o To identify SCIM attributes that may be useful in vCard too.
o To serve as guidance to consider whether vCard can be used as a
basis for SCIM.
o To provide discussion material on whether vCard could replace the
SCIM schema completely.
The SCIM WG is recommended to consider these issues.
Greevenbosch Expires March 17, 2013 [Page 4]
Internet-Draft SCIM/vCard mapping September 2012
2. Requirements notation
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
Greevenbosch Expires March 17, 2013 [Page 5]
Internet-Draft SCIM/vCard mapping September 2012
3. Mapping from SCIM attributes to vCard properties
Table 1 describes a mapping from SCIM attributes to the vCard
properties.
The reverse mapping from vCard to SCIM is defined in Section 4. The
reason for having two tables is that some mappings are not
invertible.
+----------------------+--------------------+-----------------------+
| SCIM attribute | vCard property | Notes |
+----------------------+--------------------+-----------------------+
| id | UID | May need conversion |
| | | from SCIM id space to |
| | | vCard UID space. |
| | | Exact conversion TBD. |
| | | |
| externalId | | |
| | | |
| meta/created | | |
| | | |
| meta/lastModified | REV | |
| | | |
| meta/location | | |
| | | |
| meta/version | | |
| | | |
| meta/attributes | | |
| | | |
| userName | | |
| | | |
| name/formatted | FN | |
| | | |
| name/familyName | N (family names) | Combined with other |
| | | name attributes in a |
| | | single N element. |
| | | |
| name/givenName | N (given names) | Combined with other |
| | | name attributes in a |
| | | single N element. |
| | | |
| name/middleName | N (additional | Combined with other |
| | names) | name attributes in a |
| | | single N element. |
| | | |
| name/honorificPrefix | N (honorific | Combined with other |
| | prefixes) | name attributes in a |
| | | single N element. |
Greevenbosch Expires March 17, 2013 [Page 6]
Internet-Draft SCIM/vCard mapping September 2012
| name/honorificSuffix | N (honorific | Combined with other |
| | suffixes) | name attributes in a |
| | | single N element. |
| | | |
| displayName | | |
| | | |
| nickName | NICKNAME | |
| | | |
| profileUrl | URL | |
| | | |
| employeeNumber | | |
| | | |
| title | TITLE | |
| | | |
| userType | ROLE | Consider distinction |
| | | with the "roles" |
| | | attribute. |
| | | |
| preferredLanguage | LANG | Language tag |
| | | according to |
| | | [RFC5646]. |
| | | |
| locale | | |
| | | |
| timezone | TZ | |
| | | |
| active | | |
| | | |
| password | | |
| | | |
| costCenter | | |
| | | |
| organization | ORG | |
| | | |
| division | | |
| | | |
| department | | |
| | | |
| manager/managerId | | SCIM specific ID, |
| | | related to "id" |
| | | attribute. |
| | | |
| manager/displayName | | |
| | | |
| email | EMAIL | |
| | | |
Greevenbosch Expires March 17, 2013 [Page 7]
Internet-Draft SCIM/vCard mapping September 2012
| phoneNumber | TEL | |
| (type="work") | (TYPE="voice,work" | |
| | ) | |
| | | |
| phoneNumber | TEL | |
| (type="home") | (TYPE="voice,home" | |
| | ) | |
| | | |
| phoneNumber | TEL (TYPE="cell") | |
| (type="mobile") | | |
| | | |
| phoneNumber | TEL (TYPE="fax") | |
| (type="fax") | | |
| | | |
| phoneNumber | TEL (TYPE="pager") | |
| (type="pager") | | |
| | | |
| phoneNumber | TEL (no TYPE) | |
| (type="other") | | |
| | | |
| phoneNumber (no | TEL (no TYPE) | |
| type) | | |
| | | |
| im | IMPP | |
| | | |
| photo | PHOTO | URL of a web location |
| | | where the photo can |
| | | be retrieved. |
| | | |
| address | ADR | See [RFC6350] for the |
| | | internal coding of |
| | | the ADR property. |
| | | |
| address/formatted | ADR | MUST to be split into |
| | | separate components. |
| | | In case of ambiguity |
| | | with other address |
| | | components (e.g. |
| | | address/streetAddress |
| | | and address/region), |
| | | those components |
| | | prevail. |
| | | |
| address/streetAddres | ADR (street | Combined with other |
| s | address) | address attributes |
| | | into a single ADR |
| | | element. |
| | | |
Greevenbosch Expires March 17, 2013 [Page 8]
Internet-Draft SCIM/vCard mapping September 2012
| address/locality | ADR (locality) | Combined with other |
| | | address attributes |
| | | into a single ADR |
| | | element. |
| | | |
| address/region | ADR (region) | Combined with other |
| | | address attributes |
| | | into a single ADR |
| | | element. |
| | | |
| address/postalCode | ADR (postal code) | Combined with other |
| | | address attributes |
| | | into a single ADR |
| | | element. |
| | | |
| address/country | ADR (country) | Combined with other |
| | | address attributes |
| | | into a single ADR |
| | | element. |
| | | |
| group/displayName | FN | vCard KIND property |
| | | MUST equal "group". |
| | | |
| group/members | multiple MEMBER | Multiple SCIM |
| | properties | specific IDs, related |
| | | to "id" attribute. |
| | | Conversion between |
| | | SCIM id and vCard UID |
| | | TBD. |
| | | |
| emails | Multiple EMAIL | See "email" for |
| | fields | mapping per property. |
| | | |
| phoneNumbers | Multiple TEL | See "phoneNumber" for |
| | properties | mapping per property. |
| | | |
| ims | Multiple IMPP | See "im" for mapping |
| | properties | per property. |
| | | |
| photos | Multiple PHOTO | See "photo" for |
| | properties | mapping per property. |
| | | |
| addresses/* | Multiple ADR | See "address/*" for |
| | fields | mapping per address. |
| | | |
| groups | | Related to "group" |
| | | attribute. |
| | | |
Greevenbosch Expires March 17, 2013 [Page 9]
Internet-Draft SCIM/vCard mapping September 2012
| entitlements | | Hard to map as it is |
| | | proprietary by |
| | | nature. |
| | | |
| roles | Multiple ROLE | Consider distinction |
| | properties | with the "userType" |
| | | attribute. |
| | | |
| x509Certificates | KEY | Care is required: |
| | | keys may not have the |
| | | same usage. |
+----------------------+--------------------+-----------------------+
Table 1: SCIM to vCard mapping
Greevenbosch Expires March 17, 2013 [Page 10]
Internet-Draft SCIM/vCard mapping September 2012
4. Mapping from vCard properties to SCIM attributes
Table 2 describes a mapping from vCard properties to SCIM attributes.
+--------------------+-------------------------+--------------------+
| vCard property | SCIM attribute | Notes |
+--------------------+-------------------------+--------------------+
| SOURCE | | |
| | | |
| KIND | | In vCard can have |
| | | the values |
| | | "individual", |
| | | "group", "org" and |
| | | "location". |
| | | |
| XML | | Purpose: to |
| | | include extended |
| | | XML-encoded vCard |
| | | data in a plain |
| | | vCard. |
| | | |
| FN | name/formatted | |
| | | |
| N (family names) | name/familyName | Additional |
| | | analysis the N |
| | | property may be |
| | | needed, as vCard |
| | | does not provide |
| | | an unambigious |
| | | separation of its |
| | | components. |
| | | |
| N (given names) | name/givenName | Additional |
| | | analysis the N |
| | | property may be |
| | | needed, as vCard |
| | | does not provide |
| | | an unambigious |
| | | separation of its |
| | | components. |
| | | |
Greevenbosch Expires March 17, 2013 [Page 11]
Internet-Draft SCIM/vCard mapping September 2012
| N (additional | name/middleName | Additional |
| names) | | analysis the N |
| | | property may be |
| | | needed, as vCard |
| | | does not provide |
| | | an unambigious |
| | | separation of its |
| | | components. |
| | | |
| N (honorific | name/honorificPrefix | Additional |
| prefixes) | | analysis the N |
| | | property may be |
| | | needed, as vCard |
| | | does not provide |
| | | an unambigious |
| | | separation of its |
| | | components. |
| | | |
| N (honorific | name/honorificSuffix | Additional |
| suffixes) | | analysis the N |
| | | property may be |
| | | needed, as vCard |
| | | does not provide |
| | | an unambigious |
| | | separation of its |
| | | components. |
| | | |
| NICKNAME | nickName | |
| | | |
| PHOTO | photo | URL of a web |
| | | location where the |
| | | photo can be |
| | | retrieved. |
| | | |
| BDAY | | |
| | | |
| ANIVERSARY | | |
| | | |
| GENDER | | Can have the |
| | | values "M"ale, |
| | | "F"emale, "O"ther, |
| | | "N"one or not |
| | | applicable or |
| | | "U"nknown. |
| | | |
| ADR (post office | address/streetAddress | |
| box) | | |
| | | |
Greevenbosch Expires March 17, 2013 [Page 12]
Internet-Draft SCIM/vCard mapping September 2012
| ADR (extended | | |
| address) | | |
| | | |
| ADR (street | address/streetAddress | |
| address) | | |
| | | |
| ADR (locality) | address/locality | |
| | | |
| ADR (region) | address/region | |
| | | |
| ADR (postal code) | address/postalCode | |
| | | |
| ADR (country) | address/country | |
| | | |
| TEL (TYPE="text") | phoneNumber, | |
| | type="other" | |
| | | |
| TEL (TYPE="voice") | phoneNumber, | The vCard TYPE can |
| | type="work"/type="home" | include "work" or |
| | | "home", in which |
| | | case mapping is |
| | | clear. |
| | | |
| TEL (TYPE="fax") | phoneNumber, type="fax" | |
| | | |
| TEL (TYPE="cell") | phoneNumber, | |
| | type="mobile" | |
| | | |
| TEL (TYPE="video") | phoneNumber, | |
| | type="other" | |
| | | |
| TEL (TYPE="pager") | phoneNumber, | |
| | type="pager" | |
| | | |
| TEL | phoneNumber, | |
| (TYPE="textphone") | type="other" | |
| | | |
| TEL (no TYPE) | phoneNumber (no type) | |
| | | |
| EMAIL | email | Can have |
| | | TYPE="work", |
| | | TYPE="home". |
| | | |
| IMPP | im | |
| | | |
| LANG | preferredLanguage | |
| | | |
| TZ | timezone | |
Greevenbosch Expires March 17, 2013 [Page 13]
Internet-Draft SCIM/vCard mapping September 2012
| GEO | | GPS coordinates |
| | | |
| TITLE | title | |
| | | |
| ROLE | userType | |
| | | |
| LOGO | | |
| | | |
| ORG | organization | |
| | | |
| MEMBER | | Contains a vCard |
| | | ID of a member of |
| | | this group. The |
| | | vCard MUST have |
| | | KIND="group". |
| | | |
| RELATED | | Contains a vCard |
| | | ID of another |
| | | related vCard. |
| | | Can have many TYPE |
| | | values, such as |
| | | "friend", |
| | | "neighbor" and |
| | | "spouse". |
| | | |
| CATHEGORIES | | Contains not |
| | | necessarily |
| | | unified tags. |
| | | |
| NOTE | | Any text. |
| | | |
| PRODID | | ID for producer of |
| | | vCard. |
| | | |
| REV | | Purpose: to |
| | | specify revision |
| | | information about |
| | | the current vCard. |
| | | |
| SOUND | | |
| | | |
| UID | externalId | Conversion scheme |
| | | between vCard and |
| | | SCIM IDs is |
| | | needed. |
| | | |
Greevenbosch Expires March 17, 2013 [Page 14]
Internet-Draft SCIM/vCard mapping September 2012
| CLIENTPIDMAP | | Link between local |
| | | PID and global |
| | | URI. |
| | | |
| URL | profileUrl | |
| | | |
| VERSION | | Version of vCard |
| | | specification. |
| | | |
| KEY | x501Certificates? | Care is required: |
| | | keys may not have |
| | | the same usage. |
| | | |
| FBURL | | Purpose: to |
| | | specify the URI |
| | | for the busy time |
| | | associated with |
| | | the object that |
| | | the vCard |
| | | represents. |
| | | |
| CALADRURI | | Purpose: to |
| | | specify the |
| | | calendar user |
| | | address to which a |
| | | scheduling request |
| | | should be sent for |
| | | the object |
| | | represented by the |
| | | vCard. |
| | | |
| CALURI | | Purpose: to |
| | | specify the URI |
| | | for a calendar |
| | | associated with |
| | | the object |
| | | represented by the |
| | | vCard. |
+--------------------+-------------------------+--------------------+
Table 2: vCard to SCIM mapping
Greevenbosch Expires March 17, 2013 [Page 15]
Internet-Draft SCIM/vCard mapping September 2012
5. Open issues
The following is a list of open issues:
o Mapping between SCIM IDs and vCard UIDs.
o Text in [I-D.scim-core-schema] defines only plural "emails",
"phoneNumbers", "ims", "photos", "addresses", "groups",
"entitlements" and "roles" elements. However, the XML examples
show that these plural element contain the associated singular
elements. This is not the case for the JSON representation.
Greevenbosch Expires March 17, 2013 [Page 16]
Internet-Draft SCIM/vCard mapping September 2012
6. IANA Considerations
This document contains no requirements for IANA.
Greevenbosch Expires March 17, 2013 [Page 17]
Internet-Draft SCIM/vCard mapping September 2012
7. Security Considerations
The mapping between vCard and SCIM may be useful for easily
transferring data for one system towards another. However, it also
has privacy implications. Therefore, it is important that user
consensus is acquired where applicable.
For this document, some decisions were made concerning mapping
between attributes and properties with similar, but not equal,
semantics. This was done in a best effort manner. However one
should realise that during the mapping process some accuracy from the
original data may be lost.
Greevenbosch Expires March 17, 2013 [Page 18]
Internet-Draft SCIM/vCard mapping September 2012
8. Acknowledgements
Thanks to Kepeng Li for providing feedback and suggestions. Thanks
to Paul Madsen and Phil Hunt for providing similar mapping drafts
[draft-scim-saml2-binding] and [I-D.hunt-scim-directory], which have
served as inspiration for this document.
Greevenbosch Expires March 17, 2013 [Page 19]
Internet-Draft SCIM/vCard mapping September 2012
9. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", BCP 47, RFC 5646, September 2009.
[RFC6350] Perreault, S., "vCard Format Specification", RFC 6350,
August 2011.
[I-D.scim-core-schema]
Mortimore, C., Harding, P., Madsen, P., and T. Drake,
"System for Cross-Domain Identity Management: Core
Schema", draft-ietf-scim-core-schema-00 (work in
progress), August 2012.
[I-D.hunt-scim-directory]
Hunt, P., "SCIM Directory Services",
draft-hunt-scim-directory-00 (work in progress),
September 2012.
[draft-scim-saml2-binding]
Madsen, P., "SAML 2.0 Binding for SCIM",
draft-scim-saml2-binding-02 (work in progress),
April 2011.
Greevenbosch Expires March 17, 2013 [Page 20]
Internet-Draft SCIM/vCard mapping September 2012
Author's Address
Bert Greevenbosch
Huawei Technologies Co., Ltd.
Huawei Industrial Base
Bantian, Longgang District
Shenzhen 518129
P.R. China
Phone: +86-755-28978088
Email: bert.greevenbosch@huawei.com
Greevenbosch Expires March 17, 2013 [Page 21]