Platforms to show: All Mac Windows Linux Cross-Platform
Back to CSIdentityMBS class.
CSIdentityMBS.AddAlias(alias as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This change must be committed.
CSIdentityMBS.AddMember(user as CSIdentityMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
User: The identity to add to the group. Can be a user or group identity.
Please call only on group identities.
This change to the group must be committed.
CSIdentityMBS.Aliases as string()
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns an array containing the identity's name aliases as strings. The array may be empty.
Aliases are alternate names for identities. As with all identity names, aliases must be unique within the entire namespace of of the identity authority.
CSIdentityMBS.AuthenticateUsingPassword(password as string) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
password: The password to authenticate
Returns true if the passord is correct for the specified user.
Please call only on user identity.
CSIdentityMBS.Commit as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
error: Optional variant for CFErrorMBS which will be set if this function returns false. When this occurs, the caller is responsible for releasing the error.
Returns true if successful, false if an error occurred.
See also:
CSIdentityMBS.Commit(byref error as Variant) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
error: Optional variant for CFErrorMBS which will be set if this function returns false. When this occurs, the caller is responsible for releasing the error.
Returns true if successful, false if an error occurred.
See also:
CSIdentityMBS.Constructor(identityClass as Integer, fullName as string, posixName as string, flags as Integer, authority as CSIdentityAuthorityMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
identityClass: The type of identity to be created. Specifying kCSIdentityClassUser creates a user, while kCSIdentityClassGroup creates a group.
fullName: The primary name of the new identity.
posixName: The POSIX name of the new identity. Specify kCSIdentityGeneratePosixName to have a name generated autmatically from the full name.
flags: Attributes of the new identity
authority: The identity authority to host the identity. Caller must have write access to the identity authority or commit will fail. Currently, only local identities may be created, so callers must specify the local identity authority for this argument.
On success the handle property is not zero.
The new identity is allocated but is not committed to the identity authority's database. It will become persistent and available to other clients after being committed using Commit or CommitAsynchronously.
CSIdentityMBS.copy as CSIdentityMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Sets an identity to deleted state. This change must be committed.
CSIdentityMBS.GroupMembershipQuery as CSIdentityQueryMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Please call on the group identity whose members are to be queried
Returns the CSIdentityQueryMBS of the newly created object. The query is ready to be executed.
Using a query to lookup group membership allows the caller to execute the query synchronously or asynchronously.
CSIdentityMBS.IsMemberOfGroup(group as CSIdentityMBS) as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Please call only on a group identity.
group: The group identity whose membership is to be checked
Returns true if the identity is a member (directly or indirectly) of the specified group
CSIdentityMBS.PersistentReference as memoryblock
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns a new persistent reference for the identity.
A persistent identity reference is an opaque data object from which an identity object may queried the future (see CreateForPersistentReference). A persistent reference is suitable for storage in an external data store, for example, as an entry in an application-specific access control list associated with a shared resource. Use of a persistent identity reference is preferred over a pure UUID-based identity reference because the persistent reference contains additional information needed to optimize the identity query and to improve the user experience when working in a distributed identity environment (LDAP, Active Directory, etc.).
CSIdentityMBS.RemoveAlias(alias as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
alias: The alias name to remove
This change must be committed.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
After returning, this function guarantees that client event will never be invoked again. Use this function when releasing an identity which may have an outstanding asynchronous request. This function does not cancel an outstanding commit operation because a commit cannot be interrupted.
CSIdentityMBS.RemoveMember(user as CSIdentityMBS)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Please call only on group identities.
member: The member identity to remove
This change to the group must be committed.
CSIdentityMBS.SetEmailAddress(email as string = "")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
emailAddress: The user's new email address value. Pass "" to remove an email address.
This change must be committed.
CSIdentityMBS.SetFullName(name as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
fullName: The new full name of the identity
This change must be committed.
CSIdentityMBS.SetImageData(data as memoryblock = nil, datatype as string = "public.jpeg")
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
imageData: The image data. Pass nil to remove image data.
imageDataType: The uniform type identitier (UTI) of the image data. Currently, kUTTypeJPEG ("public.jpeg") is the only type supported.
This change must be committed.
CSIdentityMBS.SetImageURL(URL as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
url: The URL file of the image. For local identities, this must be a file URL. Pass "" to remove the image URL from the identity.
This change must be committed.
CSIdentityMBS.SetIsEnabled(value as boolean)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
isEnabled: The new value of the isEnabled attribute
A disabled user account cannot authenticate. Credentials (password and certificate) are not affected. This change must be committed.
CSIdentityMBS.SetPassword(password as string)
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Collaboration | MBS MacFrameworks Plugin | 13.0 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Please call only on user identites.
password: The new password, or "" to remove the current password and disable password-based authentication.
Setting the password to "" removes the current password and disables password authentication for the user. Setting the password to a zero-length string allows authentication with a blank password. This change must be committed.
The items on this page are in the following plugins: MBS MacFrameworks Plugin.