Google Apps Script API
    Preparing search index...

    Interface Permission

    A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as permissions.update) require a permissionId. Use the permissions.list method to retrieve the ID for a file, folder, or shared drive.

    interface Permission {
        allowFileDiscovery?: boolean;
        deleted?: boolean;
        displayName?: string;
        domain?: string;
        emailAddress?: string;
        expirationTime?: string;
        id?: string;
        kind?: string;
        pendingOwner?: boolean;
        permissionDetails?: GoogleAppsScript.Drive_v3.Drive.V3.Schema.PermissionPermissionDetails[];
        photoLink?: string;
        role?: string;
        teamDrivePermissionDetails?: GoogleAppsScript.Drive_v3.Drive.V3.Schema.PermissionTeamDrivePermissionDetails[];
        type?: string;
        view?: string;
    }
    Index

    Properties

    allowFileDiscovery? deleted? displayName? domain? emailAddress? expirationTime? id? kind? pendingOwner? permissionDetails? photoLink? role? teamDrivePermissionDetails? type? view?

    Properties
    allowFileDiscovery?: boolean

    Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.

    deleted?: boolean

    Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

    displayName?: string

    Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * user - User's full name,as defined for their Google account,such as"Joe Smith." * group - Name of the Google Group, such as "The Company Administrators." * domain - String domain name, such as "thecompany.com." * anyone - No displayName is present.

    domain?: string

    The domain to which this permission refers.

    emailAddress?: string

    The email address of the user or group to which this permission refers.

    expirationTime?: string

    The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future

    id?: string

    Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values.

    kind?: string

    Output only. Identifies what kind of resource this is. Value: the fixed string "drive#permission".

    pendingOwner?: boolean

    Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive.

    permissionDetails?: GoogleAppsScript.Drive_v3.Drive.V3.Schema.PermissionPermissionDetails[]

    Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

    photoLink?: string

    Output only. A link to the user's profile photo, if available.

    role?: string

    The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * owner * organizer * fileOrganizer * writer * commenter * reader

    teamDrivePermissionDetails?: GoogleAppsScript.Drive_v3.Drive.V3.Schema.PermissionTeamDrivePermissionDetails[]

    Output only. Deprecated: Output only. Use permissionDetails instead.

    type?: string

    The type of the grantee. Valid values are: * user * group * domain * anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for an anyone type.

    view?: string

    Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.

    Settings
    Member Visibility

    On This Page
    Properties