<!--
{
  "availability" : [
    "macOS: 10.5.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Collaboration",
  "identifier" : "/documentation/Collaboration/CBIdentity",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Collaboration"
    ],
    "preciseIdentifier" : "c:objc(cs)CBIdentity"
  },
  "title" : "CBIdentity"
}
-->

# CBIdentity

A `CBIdentity` object is used for accessing the attributes of an identity stored in an identity authority. You can use an identity object for finding identities, and storing them in an access control list (ACL). If you need to edit these attributes, take advantage of the `CSIdentity` class in Core Services.

```
class CBIdentity
```

## Overview

You can obtain a `CBIdentity` object from one of the following class factory methods: [`init(name:authority:)`](/documentation/Collaboration/CBIdentity/init(name:authority:)), [`init(uuidString:authority:)`](/documentation/Collaboration/CBIdentity/init(uuidString:authority:)-13vns), [`init(persistentReference:)`](/documentation/Collaboration/CBIdentity/init(persistentReference:)), or [`identityWithCSIdentity:`](/documentation/Collaboration/CBIdentity/identityWithCSIdentity:).

A `CBIdentity` object has methods to support for interoperability with the Core Services Identity API. Send [`CSIdentity`](/documentation/Collaboration/CBIdentity/CSIdentity) to your `CBIdentity` object to return an opaque object for use in the Core Services Identity API. Similarly, call [`identityWithCSIdentity:`](/documentation/Collaboration/CBIdentity/identityWithCSIdentity:) to use an Core Services Identity opaque object in the Collaboration framework.

There are two subclasses of `CBIdentity`: `CBGroupIdentity` and `CBUserIdentity`. If you are working specifically with a group identity, use `CBGroupIdentity`. Similarly, if you are working with a user identity, use `CBUserIdentity`.

## Topics

### Finding Identities

[`+  identityWithCSIdentity:`](/documentation/Collaboration/CBIdentity/identityWithCSIdentity:)

Returns an identity object created from the specified Core Services Identity opaque object.

[`+  identityWithName:authority:`](/documentation/Collaboration/CBIdentity/init(name:authority:))

Returns the identity object with the given name from the specified identity authority.

[`+  identityWithPersistentReference:`](/documentation/Collaboration/CBIdentity/init(persistentReference:))

Returns the identity object matching the persistent reference data.

[`+  identityWithUUIDString:authority:`](/documentation/Collaboration/CBIdentity/init(uuidString:authority:)-13vns)

Returns the identity object with the given UUID from the specified identity authority.

### Getting Identity Attributes

[`aliases`](/documentation/Collaboration/CBIdentity/aliases)

Returns an array of aliases (alternate names) for the identity.

[`authority`](/documentation/Collaboration/CBIdentity/authority)

Returns the identity authority where the identity is stored.

[`emailAddress`](/documentation/Collaboration/CBIdentity/emailAddress)

Returns the email address of an identity.

[`fullName`](/documentation/Collaboration/CBIdentity/fullName)

Returns the full name of the identity.

[`image`](/documentation/Collaboration/CBIdentity/image)

Returns the image associated with an identity.

[`hidden`](/documentation/Collaboration/CBIdentity/isHidden)

Returns a Boolean value indicating the state of the identity’s hidden property.

[`-  isMemberOfGroup:`](/documentation/Collaboration/CBIdentity/isMember(ofGroup:))

Returns a Boolean value indicating whether the identity is a member of the specified group.

[`posixName`](/documentation/Collaboration/CBIdentity/posixName)

Returns the POSIX name of the identity.

[`UUIDString`](/documentation/Collaboration/CBIdentity/uuidString)

Returns the UUID of the identity as a string.

### Storing Identities

[`CSIdentity`](/documentation/Collaboration/CBIdentity/CSIdentity)

Returns an opaque object for use with the Core Services Identity API.

[`persistentReference`](/documentation/Collaboration/CBIdentity/persistentReference)

Returns a persistent reference to store a reference to an identity.

## Relationships

### Conforms To

[`Hashable`](/documentation/Swift/Hashable)

[`Equatable`](/documentation/Swift/Equatable)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`NSCoding`](/documentation/Foundation/NSCoding)

[`CVarArg`](/documentation/Swift/CVarArg)

[`NSCopying`](/documentation/Foundation/NSCopying)

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

### Inherited By

[`CBUserIdentity`](/documentation/Collaboration/CBUserIdentity)

[`CBGroupIdentity`](/documentation/Collaboration/CBGroupIdentity)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)