Identity

Identity/get

Capability: urn:ietf:params:jmap:submission

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to fetch Identity objects from.
ids	array?	No	Identity ids to fetch. If null, returns all identities.
properties	array?	No	Identity properties to return. Defaults to all properties.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account the Identity objects belong to.
state	string	Yes	Current Identity state, used in subsequent /changes calls.
list	Identity[]	Yes	The requested Identity objects.
notFound	array?	No	Ids that were not found.

Identity/set

Capability: urn:ietf:params:jmap:submission

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to update Identity objects in.
ifInState	string?	No	Optimistic concurrency guard on Identity state.
create	object?	No	Map of creation id to Identity create objects. This server does not support client-initiated creation.
update	object?	No	Map of Identity id to IdentityUpdate patch objects.
destroy	array?	No	Ids to destroy. This server does not support client-initiated destruction.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account the set operation was performed on.
oldState	string?	Yes	The Identity state before this call, or null if no prior state existed.
newState	string	Yes	The Identity state after this call.
created	object?	No	Map of creation id to the created Identity object (server-initiated only).
updated	object?	No	Map of id to the updated Identity object (or null if unchanged properties were not returned).
destroyed	array?	No	Ids of Identity objects that were successfully destroyed (server-initiated only).
notCreated	object?	No	Map of creation id to SetError for each failed create.
notUpdated	object?	No	Map of id to SetError for each failed update.
notDestroyed	object?	No	Map of id to SetError for each failed destroy.

Identity/changes

Capability: urn:ietf:params:jmap:submission

Arguments

Property	Type	Required	Description
accountId	AccountId	Yes	The account to get Identity changes for.
sinceState	string	Yes	The state to get changes since.
maxChanges	integer?	No	Maximum number of changes to return.

Response

Property	Type	Required	Description
accountId	AccountId	Yes	The account these changes are for.
oldState	string	Yes	The sinceState value passed in the request.
newState	string	Yes	The current Identity state after these changes.
hasMoreChanges	boolean	Yes	If true, more changes exist beyond maxChanges; make another call with newState as sinceState.
created	Id[]	Yes	Identity ids created since sinceState.
updated	Id[]	Yes	Identity ids updated since sinceState.
destroyed	Id[]	Yes	Identity ids destroyed since sinceState.