RapidIdentity Product Guide

id

Y

the id of the Group to be updated (exclude on create)

groupId (required for create)

N

the email address of the Group

groupName (required for create)

N

the name of the Group

description

Y

the description of the Group

member

Y

list of members of the Group

etag

Y

eTag of the resource

whoCanAdd

N

the members that can add members to the Group. can be set to all members, managers, or none

whoCanJoin

N

the members that can join the Group. can be set to members in any domain, by request, or invitation

whoCanViewGroup

N

the members that can view to the Group. can be set to members in the domain, managers, members, or anyone

whoCanLeaveGroup

N

the members that can leave the Group. can be set to all members, managers, or none

whoCanContactOwner

N

the members that can contact the Group owner. can be set to all in the domain, members, managers, or anyone

id

Y

the id of the Alias (exclude on create)

alias

Y

the Alias email address

primaryEmail

Y

The aliased User's/Group's primary email address

etag

Y

eTag of the resource

id

Y

the id of the OrgUnit (exclude on create)

name

N

the simple name of the OrgUnit

parentOrgUnitPath

N

the full path name of the OrgUnit parent

description

N

the description of the OrgUnit

blockInheritance

N

block policy inheritance from OrgUnits higher in the OrgUnit tree (“true”/“false”)

orgUnitPath

Y

the full pathname of the OrgUnit

etag

Y

eTag of the resource

id

Y

the id of the Contact (exclude on create)

namePrefix

N

Honorific prefix of the Contact, e.g. 'Mr' or 'Mrs'

givenName

N

given name of the Contact

additionalName

N

additional name of the Contact, eg. middle name

familyName

N

family name of the Contact

nameSuffix

N

Honorific suffix of the Contact, e.g. 'Jr' or 'MD'

fullName

N

Unstructured representation of the name of the Contact

content

N

notes about the Contact

email

N

Contact Email Record Fields

im

N

Contact IM Record Fields

organization

N

Contact Organization Record Fields

phoneNumber

N

Contact Phone Number Record Fields

structuredPostalAddress

N

Contact Postal Address Record Fields

where

N

place associated with the Contact

extendedProperty

N

Contact Extended Property Record Fields

title

Y

the title of the Contact

updated

Y

the date the Contact record was last updated

id

Y

the id of the Resource (exclude on create)

resourceId (required for create)

N

the unique name of the Resource

resourceName

N

the name of the Resource

resourceDescription

N

the description of the Resource

resourceEmail

Y

the email address of the Resource and the id of the associated associated Calendar)

resourceType

N

the type of the Resource

resourceCommonName

N

the display name of the Resource (DEPRECATED - use resourceName)

userId

N

the id of the User the Send-As Alias will apply to

name

N

the name associated with the Send-As Alias

address

N

the email address of the Send-As Alias

replyTo

N

optional reply-to address of Send-As Alias

makeDefault

N

the make the Send-As Alias the default for the User

isDefault

Y

indicates whether or not the Send-As Alias is currently default for the User

verified

Y

indicates if the ownership of the email address's domain has been verified. This field must be true (verified), before the Send-As alias address can work.

id

Y

 The id of the schema

schemaName

 N

The name of the custom schema

schemaId

Y

The unique identifier of the schema

fields

N

1 or more Custom Field Definition Records

address (required)

the email address

displayName

the display name of the entity the email address belongs to

label

name for the email address, e.g. Work, Personal, Preferred, etc.

rel

the type of email: one of home, work, or other

primary

boolean indicating this is the primary email address

address (required)

the instant messaging address

label

name for the email address, e.g. Work, Personal, Preferred, etc.

rel

the type of IM: one of home, netmeeting, work, or other

protocol

the IM protocol: one of AIM, MSN, YAHOO, SKYPE, QQ, GOOGLE_TALK, ICQ, JABBER

primary

boolean indicating this is the primary im address

orgDepartment

the department within the organization

orgName

the name of the organization

orgSymbol

the symbol of the organization

orgTitle

the title of the person of the organization

orgJobDescription

the job description of the person within the organization

label

label for the organization, e.g. Work, Volunteer, etc.

rel

the type of organization: one of work, or other

primary

boolean indicating this is the primary organization for the person

where

a place associated with the organization, e.g. office location

number (required)

the phone number

label

name for the phone number, e.g. Work, Personal, Preferred, etc.

rel

the type of phone number: one of assistant, callback, car, company_main, fax, home, home_fax, isdn, main, mobile, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager, other_fax, or other

uri

URI of phone number for VOIP access

primary

boolean indicating this is the primary phone number

street

the street address

pobox

the post office box

neighborhood

the neighborhood

city

the city

region

state, province, etc

postcode

postal code

country

name of the country

countryCode

country code

formattedAddress

the full, unstructured postal address

label

name of the address, e.g. Work, Personal, Preferred, etc.

rel

the type of address: one of work, home, or other

primary

boolean indicating this is the primary phone number

name

the name of the extended property

realm

the realm of the extended property

value

the value of the extended property

address

the email address

primary

indicates if this is the user's primary email

type

the type of the email account: “home”, “work”, “other”, “custom”

customType

if the value of type is custom, this field contains the custom type string

im

the user's IM network ID

primary

indicates this is the user's primary IM

protocol

the IM protocol: “aim”, “gtalk”, “icq”, “jabber”, “msn”, “net_meeting”, “qq”, “skype”, “yahoo”, “custom_protocol”

customProtocol

if the protocol value is custom_protocol, this field holds the custom protocol's string

type

the type of the IM account: “home”, “work”, “other”, “custom”

customType

if the IM type is custom, this field holds the custom type string

costCenter

the cost center of the organization

department

the department within the organization

description

the description of the organization

domain

the domain the organization belongs to

location

the physical location of the organization

name

the name of the organization

primary

indicates if this is the user's primary organization

symbol

text string symbol of the organization

title

the user's title within the organization

type

the type of organization: “unknown”, “school”, “work”, “domain_only”, “custom”

customType

if the value of type is custom, this field contains the custom type

value

a human-readable phone number

primary

indicates if this is the user's primary phone number

type

the type of phone number: “assistant”, “callback”, “car”, “company_main”, “grand_central”, “home”, “home_fax”, “isdn”, “main”, “mobile”, “other”, “other_fax”, “pager”, “radio”, “telex”, “tty_tdd”, “work”, “work_fax”, “work_mobile”, “work_pager”, “custom”

customType

if the value of type is custom, this field contains the custom type

country

the country

countryCode

the country code

extendedAddress

for extended addresses, such as an address that includes a sub-region

formatted

a full and unstructured postal address

locality

the town or city of the address

poBox

the post office box

postalCode

the ZIP or postal code

primary

indicates if this is the user's primary address

region

the abbreviated province or state

sourceIsStructured

indicates if the user-supplied address was formatted

streetAddress

the street address

type

the address type: “home”, “other”, “work”, “custom”

customType

if the address type is custom, this field contains the custom value

value

the value of the ID

type

the type of the ID. Allowed values are: “account”, “custom”, “customer”, “network”, “organization”

customType

if the external ID type is custom, this field holds the custom type

value

the name of the person the user is related to

type

the type of relation: “assistant”, “brother”, “child”, “domestic_partner”, “father”, “friend”, “manager”, “mother”, “parent”, “partner”, “referred_by”, “relative”, “sister”, “spouse”, “custom”

customType

if the value of type is custom, this field contains the custom type

<schema_name>

Record containing the custom schema fields for the schema with name schema_name

<schema_name>.<field_name>

For single valued fields, the value of the field For multi-valued fields, 0 or more User Custom Schema Multivalued Value Record