| Feature | Version | |
|---|---|---|
| directories | 4 |
| Feature | Version | |
|---|---|---|
| directories | 4 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
The directory's access rights. This property will be omitted if there are no access rights to this directory.
Prior to version 8 the server was sending only admin property if the loggedin user is having the Directory Administrator ACL, which is insufficient to decide if the directory is read only.
| Feature | Version | |
|---|---|---|
| directories | 8 |
Required
The directory's ID.Required
The directory's display name.Required
The directory's schema ID.Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Property type documentation:
A bit-flag like type used for pending directory categories - ones whose contact lists have yet to finish loading. Values will only ever be returned as true, and should be interpreted in the context of their message. For example, a publicPendingCategoriesAdded message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are pending. A subsequent privatePendingCategoriesRemoved message, with pendingCategories.workgroup = true, would indicate that private workgroup directories are no longer pending.
Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| directories | 4 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.