Platforms to show: All Mac Windows Linux Cross-Platform

Back to CBIdentityMBS class.

CBIdentityMBS.aliases as string()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an array of aliases (alternate names) for the identity.

Returns an array of strings containing the alternate names for the identity.
An identity can have zero or more aliases. Like the full and short names, two identities cannot share an alias.

CBIdentityMBS.authority as CBIdentityAuthorityMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the identity authority where the identity is stored.

CBIdentityMBS.Constructor   Private

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
The private constructor.

CBIdentityMBS.copy as CBIdentityMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Creates a copy of the object.

CBIdentityMBS.CSIdentity as Variant

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 13.0 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns an opaque object for use with the Core Services Identity API.

This method, along with identityWithCSIdentity, is used for interoperability with the Core Services Identity API.
Available in OS X v10.5 and later.

CBIdentityMBS.emailAddress as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the email address of an identity.

The email address of an identity or "" if none exists.

CBIdentityMBS.fullName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the full name of the identity.

CBIdentityMBS.image as NSImageMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the image associated with an identity.

The image associated with an identity, or nil if none exists.

CBIdentityMBS.isHidden as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns a Boolean value indicating the state of the identity's hidden property.

A hidden identity does not show up in the Identity Picker. A hidden identity refers to system identities such as root, www, and wheel.
True if the identity is hidden; false if it is not.

CBIdentityMBS.isMemberOfGroup(g as CBGroupIdentityMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns a Boolean value indicating whether the identity is a member of the specified group.

g: The group to check for membership.

Returns true if the identity is a member of the group; false if it is not.

CBIdentityMBS.persistentReference as MemoryBlock

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns a persistent reference to store a reference to an identity.

Returns a memoryblock that uniquely references an identity.

A persistent reference data object is an object generated from an identity. Persistent data objects can be written to and read from a file, making them extremely useful for storing identities in an ACL.

CBIdentityMBS.posixName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the POSIX name of the identity.

The POSIX name is also referred to as the "short name" for an identity. It can only contain the characters A-Z, a-z, 0-9, -, _, ., and @.

CBIdentityMBS.UUIDString as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Collaboration MBS MacFrameworks Plugin 12.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Returns the UUID of the identity as a string.

The UUID string is generated so it is unique across all identity authorities. When storing ACLs, one method is to store the UUID of each identity. However, it is recommended that you use a persistent data object instead (see persistentReference).

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...