Class EnterprisesResource

The "enterprises" collection of methods.

Inheritance

object

EnterprisesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.AndroidEnterprise.v1

Assembly: Google.Apis.AndroidEnterprise.v1.dll

Syntax

public class EnterprisesResource

Constructors

EnterprisesResource(IClientService)

Constructs a new resource.

Declaration

public EnterprisesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AcknowledgeNotificationSet()

Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.

Declaration

public virtual EnterprisesResource.AcknowledgeNotificationSetRequest AcknowledgeNotificationSet()

Returns

Type	Description
EnterprisesResource.AcknowledgeNotificationSetRequest

CompleteSignup()

Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.

Declaration

public virtual EnterprisesResource.CompleteSignupRequest CompleteSignup()

Returns

Type	Description
EnterprisesResource.CompleteSignupRequest

CreateEnrollmentToken(string)

Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.

Declaration

public virtual EnterprisesResource.CreateEnrollmentTokenRequest CreateEnrollmentToken(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	Required. The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.CreateEnrollmentTokenRequest

CreateWebToken(AdministratorWebTokenSpec, string)

Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information.

Declaration

public virtual EnterprisesResource.CreateWebTokenRequest CreateWebToken(AdministratorWebTokenSpec body, string enterpriseId)

Parameters

Type	Name	Description
AdministratorWebTokenSpec	body	The body of the request.
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.CreateWebTokenRequest

Enroll(Enterprise, string)

Enrolls an enterprise with the calling EMM.

Declaration

public virtual EnterprisesResource.EnrollRequest Enroll(Enterprise body, string token)

Parameters

Type	Name	Description
Enterprise	body	The body of the request.
string	token	Required. The token provided by the enterprise to register the EMM.

Returns

Type	Description
EnterprisesResource.EnrollRequest

GenerateSignupUrl()

Generates a sign-up URL.

Declaration

public virtual EnterprisesResource.GenerateSignupUrlRequest GenerateSignupUrl()

Returns

Type	Description
EnterprisesResource.GenerateSignupUrlRequest

Get(string)

Retrieves the name and domain of an enterprise.

Declaration

public virtual EnterprisesResource.GetRequest Get(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.GetRequest

GetServiceAccount(string)

Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side. This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error. Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials. Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.

Declaration

public virtual EnterprisesResource.GetServiceAccountRequest GetServiceAccount(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.GetServiceAccountRequest

GetStoreLayout(string)

Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.

Declaration

public virtual EnterprisesResource.GetStoreLayoutRequest GetStoreLayout(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.GetStoreLayoutRequest

List(string)

Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.

Declaration

public virtual EnterprisesResource.ListRequest List(string domain)

Parameters

Type	Name	Description
string	domain	Required. The exact primary domain name of the enterprise to look up.

Returns

Type	Description
EnterprisesResource.ListRequest

PullNotificationSet()

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.

Declaration

public virtual EnterprisesResource.PullNotificationSetRequest PullNotificationSet()

Returns

Type	Description
EnterprisesResource.PullNotificationSetRequest

SendTestPushNotification(string)

Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.

Declaration

public virtual EnterprisesResource.SendTestPushNotificationRequest SendTestPushNotification(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.SendTestPushNotificationRequest

SetAccount(EnterpriseAccount, string)

Sets the account that will be used to authenticate to the API as the enterprise.

Declaration

public virtual EnterprisesResource.SetAccountRequest SetAccount(EnterpriseAccount body, string enterpriseId)

Parameters

Type	Name	Description
EnterpriseAccount	body	The body of the request.
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.SetAccountRequest

SetStoreLayout(StoreLayout, string)

Sets the store layout for the enterprise. By default, storeLayoutType is set to "basic" and the basic store layout is enabled. The basic layout only contains apps approved by the admin, and that have been added to the available product set for a user (using the setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = "custom" and setting a homepage), the basic store layout is disabled.

Declaration

public virtual EnterprisesResource.SetStoreLayoutRequest SetStoreLayout(StoreLayout body, string enterpriseId)

Parameters

Type	Name	Description
StoreLayout	body	The body of the request.
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.SetStoreLayoutRequest

Unenroll(string)

Unenrolls an enterprise from the calling EMM.

Declaration

public virtual EnterprisesResource.UnenrollRequest Unenroll(string enterpriseId)

Parameters

Type	Name	Description
string	enterpriseId	The ID of the enterprise.

Returns

Type	Description
EnterprisesResource.UnenrollRequest