User

public class User : BoxModel

User of the Box application.

BoxModel

  • Box item type

    Declaration

    Swift

    public var type: String

  • Declaration

    Swift

    public private(set) var rawData: [String : Any] { get }

Properties

  • id

    Identifier

    Declaration

    Swift

    public let id: String

  • The name of the user.

    Declaration

    Swift

    public let name: String?

  • The email address the user uses to log in.

    Declaration

    Swift

    public let login: String?

  • When the user object was created.

    Declaration

    Swift

    public let createdAt: Date?

  • When the user object was last modified.

    Declaration

    Swift

    public let modifiedAt: Date?

  • The user’s preferred language.

    Declaration

    Swift

    public let language: String?

  • The user’s timezone.

    Declaration

    Swift

    public let timezone: String?

  • The user’s total available space amount in bytes.

    Declaration

    Swift

    public let spaceAmount: Int?

  • The amount of space in use by the user.

    Declaration

    Swift

    public let spaceUsed: Int?

  • The maximum individual file size in bytes the user can have.

    Declaration

    Swift

    public let maxUploadSize: Int?

  • User’s status.

    Declaration

    Swift

    public let status: UserStatus?

  • The user’s job title.

    Declaration

    Swift

    public let jobTitle: String?

  • The user’s phone number.

    Declaration

    Swift

    public let phone: String?

  • The user’s address.

    Declaration

    Swift

    public let address: String?

  • URL of the user’s avatar image.

    Declaration

    Swift

    public let avatarUrl: URL?

  • The user’s enterprise role.

    Declaration

    Swift

    public let role: String?

  • An array of key/value pairs set by the user’s admin.

    Declaration

    Swift

    public let trackingCodes: [TrackingCode]?

  • Whether the user can see other enterprise users in their contact list.

    Declaration

    Swift

    public let canSeeManagedUsers: Bool?

  • Whether the user can use Box Sync.

    Declaration

    Swift

    public let isSyncEnabled: Bool?

  • Whether the user is allowed to collaborate with users outside her enterprise.

    Declaration

    Swift

    public let isExternalCollabRestricted: Bool?

  • Whether to exempt the user from Enterprise device limits.

    Declaration

    Swift

    public let isExemptFromDeviceLimits: Bool?

  • Whether the user must use two-factor authentication.

    Declaration

    Swift

    public let isExemptFromLoginVerification: Bool?

  • Mini representation of the user’s enterprise.

    Declaration

    Swift

    public let enterprise: Enterprise?

  • Tags for all files and folders owned by the user. Values returned will only contain tags that were set by the requester.

    Declaration

    Swift

    public let myTags: [String]?

  • The root (protocol, subdomain, domain) of any links that need to be generated for the user.

    Declaration

    Swift

    public let hostname: String?

  • Whether the user is an App User.

    Declaration

    Swift

    public let isPlatformAccessOnly: Bool?

  • External app user ID.

    Declaration

    Swift

    public let externalAppUserId: String?

  • Initializer.

    Throws

    Decoding error.

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON dictionary.