Documentation

Google_Service_AndroidEnterprise_Resource_Users extends Google_Service_Resource
in package

Application

The "users" collection of methods.

Typical usage is: $androidenterpriseService = new Google_Service_AndroidEnterprise(...); $users = $androidenterpriseService->users;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deleted an EMM-managed user. (users.delete)
generateAuthenticationToken() : Google_Service_AndroidEnterprise_AuthenticationToken: Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.
get() : Google_Service_AndroidEnterprise_User: Retrieves a user's details. (users.get)
getAvailableProductSet() : Google_Service_AndroidEnterprise_ProductSet: Retrieves the set of products a user is entitled to access.
insert() : Google_Service_AndroidEnterprise_User: Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed. (users.insert)
listUsers() : Google_Service_AndroidEnterprise_UsersListResponse: Looks up a user by primary email address. This is only supported for Google- managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
revokeDeviceAccess() : mixed: Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.
setAvailableProductSet() : Google_Service_AndroidEnterprise_ProductSet: Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
update() : Google_Service_AndroidEnterprise_User: Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Deleted an EMM-managed user. (users.delete)


    public
                delete(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

generateAuthenticationToken()

Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes. You can provision a maximum of 10 devices per user. This call only works with EMM-managed accounts.


    public
                generateAuthenticationToken(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_AuthenticationToken

(users.generateAuthenticationToken)

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_AuthenticationToken —

get()

Retrieves a user's details. (users.get)


    public
                get(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_User

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_User —

getAvailableProductSet()

Retrieves the set of products a user is entitled to access.


    public
                getAvailableProductSet(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ProductSet

(users.getAvailableProductSet)

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductSet —

insert()

Creates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed. (users.insert)


    public
                insert(string $enterpriseId, Google_Service_AndroidEnterprise_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_User

Parameters

$enterpriseId : string: The ID of the enterprise.
$postBody : Google_Service_AndroidEnterprise_User
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_User —

listUsers()

Looks up a user by primary email address. This is only supported for Google- managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.


    public
                listUsers(string $enterpriseId, string $email[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_UsersListResponse

(users.listUsers)

Parameters

$enterpriseId : string: The ID of the enterprise.
$email : string: Required. The exact primary email address of the user to look up.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_UsersListResponse —

revokeDeviceAccess()

Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts.


    public
                revokeDeviceAccess(string $enterpriseId, string $userId[, array<string|int, mixed> $optParams = array() ]) : mixed

(users.revokeDeviceAccess)

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

setAvailableProductSet()

Modifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.


    public
                setAvailableProductSet(string $enterpriseId, string $userId, Google_Service_AndroidEnterprise_ProductSet $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_ProductSet

(users.setAvailableProductSet)

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$postBody : Google_Service_AndroidEnterprise_ProductSet
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_ProductSet —

update()

Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed.


    public
                update(string $enterpriseId, string $userId, Google_Service_AndroidEnterprise_User $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_AndroidEnterprise_User

Other fields must either be unset or have the currently active value. (users.update)

Parameters

$enterpriseId : string: The ID of the enterprise.
$userId : string: The ID of the user.
$postBody : Google_Service_AndroidEnterprise_User
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_AndroidEnterprise_User —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —