Mac Developer Library

Developer

Collaboration Framework Reference CBIdentityAuthority Class Reference

Options
Deployment Target:

On This Page
Language:

CBIdentityAuthority

An identity authority is a database that stores information about identities. The CBIdentityAuthority class defines one or more identity authorities. This database can be searched for identities in conjunction with the CBIdentity class factory methods.

  • Returns an identity authority for use with the Core Services Identity API.

    Declaration

    Objective-C

    @property(readonly) CSIdentityAuthorityRef CSIdentityAuthority

    Return Value

    The opaque authority object for use with the Core Services Identity API.

    Discussion

    This method, along with identityAuthorityWithCSIdentityAuthority:, is used for interoperability with the Core Services Identity API.

    Availability

    Available in OS X v10.5 and later.

  • Returns an identity authority specified by a given Core Services Identity authority object.

    Declaration

    Objective-C

    + (CBIdentityAuthority *)identityAuthorityWithCSIdentityAuthority:(CSIdentityAuthorityRef)CSIdentityAuthority

    Parameters

    CSIdentityAuthority

    The Core Services Identity opaque object.

    Return Value

    The identity authority object for use with the Collaboration framework.

    Discussion

    This method, along with CSIdentityAuthority, is used for interoperability with the Core Services Identity API.

    Availability

    Available in OS X v10.5 and later.

  • Returns the localized name of the identity authority.

    Declaration

    Swift

    var localizedName: String { get }

    Objective-C

    @property(readonly, nonatomic) NSString *localizedName

    Return Value

    The computer’s name if the authority is local, or Managed Network Directory if the authority is managed.

    Availability

    Available in OS X v10.5 and later.

  • Returns the identity authority on the local system.

    Declaration

    Swift

    class func localIdentityAuthority() -> CBIdentityAuthority

    Objective-C

    + (CBIdentityAuthority *)localIdentityAuthority

    Return Value

    The identity authority on the local system.

    Discussion

    Any identities stored on the local system are contained within this identity authority.

    Availability

    Available in OS X v10.5 and later.

  • Returns the identity authority that contains all the identities in bound network directory servers.

    Declaration

    Swift

    class func managedIdentityAuthority() -> CBIdentityAuthority

    Objective-C

    + (CBIdentityAuthority *)managedIdentityAuthority

    Return Value

    The identity authorities in bound network directory servers.

    Discussion

    If you are bound to a network directory server (such as an LDAP server) that has an identity authority, use this method to search those authorities.

    Availability

    Available in OS X v10.5 and later.

  • Returns an identity authority that contains the identities in both the local and the network-bound authorities.

    Declaration

    Swift

    class func defaultIdentityAuthority() -> CBIdentityAuthority

    Objective-C

    + (CBIdentityAuthority *)defaultIdentityAuthority

    Return Value

    The local and network-bound identity authorities.

    Discussion

    The default identity authority is the logical union of the identities in the local and managed authorities.

    Availability

    Available in OS X v10.5 and later.