Cirrus Identity API Attribute Catalog

Attribute

Description

batchId

A customer provided identifier for batch submissions of invitations

batchSize

The Size of the batch

clientRequestId

An identifier provided by the customer when submitting an invitation request and returned in the in the response

count

The number of records contained in the returned set; "count" <= "limit"

createDate

Object creation timestamp - (RFC 3339) combined date and time format in UTC

customData

Custom data for the object stored as attribute name-value pairs:

• Guest Object - custom data associated with an individual that has a guest record; the data can not be establish until the individual successfully claims an invitation
• Invitation Object - custom data associated with a specific invitation; the data can be establish at the time of creating the invitation

domain

The domain of the organization the guest is registered with

eduPersonPrincipalName

"A scoped identifier for a person. It should be represented in the form "user@scope" where 'user' is a name-based identifier for the person and where the "scope" portion MUST be the administrative domain of the identity system where the identifier was created and assigned." -- Formal Definition

NOTE: The API V1 labels this attribute as "eppn"

emailAddress

The email address associated with an error for a batch submission invitations -- Formal Definition (RFC 4524)

errors

A list of errors from the response

expirationDate

• Guest Object: The expiration date of the guest credential for the guest
• Invitation Object: The proposed expiration data for the guest to be created when the invitation is claimed; will be null once the invitation is claimed

Timestamp - (RFC 3339) combined date and time format in UTC

first

If the resulting set is paginated, the href (RFC 3986) to the first page of records for the resulting set

givenName

The part of the individual's name that is not their surname or middle name -- Formal Definition (RFC 4519)

guests

A collection of guest objects

guest

Reference to the guest object

href

A URI (RFC 3986) depending on where used in the response

• Response: the API request
• Guest Object: the individual guest
• Invitation Object: the individual invitation
• Sponsor Object: the individual sponsor

invitations

A collection of invitation objects

invitationDate

The invitation creation timestamp - (RFC 3339) combined date and time format in UTC

invitationAcceptedDate

The invitation acceptance timestamp - (RFC 3339) combined date and time format in UTC

limit

The maximum number of records in the returned set

mail

"Internet mail addresses in Mailbox (RFC 2821) form (e.g., user@example.com)" -- Formal Definition (RFC 4524) ; the "to:" for messages sent to guests

mailForInvite

The internet mail address in Mailbox (RFC 2821) form (e.g., user@example.com) that an initial invitation is sent to -- Formal Definition (RFC 4524)

message

The message associated with errors

modifyDate

Object modification timestamp - (RFC 3339) combined date and time format in UTC

next

If the resulting set is paginated, the href (RFC 3986) to the next page of records for the resulting set; will be null if "count" < "limit" or ("offset" + "count") = "totalCount" or "totalCount" <= "limit"

numberProcessed

The number of invitations that have been processed by a batch submission of invitations

offset

If the resulting set is paginated, the number of records the returned set is shifted from the first record

prev

If the resulting set is paginated, the href (RFC 3986) to the previous page of records for the resulting set; will be null if "offset" == 0 or "totalCount" <= "limit"

sn

The individual's "family" name or surname -- Formal Definition (RFC 4519)

socialProvider

The social provider that was used to claim the invitation request:

• google
• linkedin
• twitter
• weibo
• win-live
• amazon
• facebook

spEntityID

The entityID of the service provider the invitation is valid for

spName

The name of the service provider

sponsor

Reference to the sponsor object

status

Status indicator for the object:

• Guest Object: ["invited", "requires-attributes", "pending-email-validation", "valid-eligible", "valid", "expired", "invited-expired"]
• Invitation Object ["invited", "pending", "processing-invite", "claimed", "expired"]

totalCount

The total number of records contained in the resulting set to the API request

uid

The Cirrus Identity issued unique identifier for a guest object, invitation object, or sponsor object

validityPeriod

The number of days from the invitationDate the invitation request is valid