close()

Close httplib2 connections.

create(agreementAccepted=None, body=None, enterpriseToken=None, projectId=None, signupUrlName=None, x__xgafv=None)

Creates an enterprise. This is the last step in the enterprise signup flow. See also: SigninDetail

Args:
body: object, The request body.
The object takes the form of:

{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
}

agreementAccepted: boolean, Whether the enterprise admin has seen and agreed to the managed Google Play Agreement (https://www.android.com/enterprise/terms/). Do not set this field for any customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises). Set this to field to true for all EMM-managed enterprises (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).
enterpriseToken: string, The enterprise token appended to the callback URL. Set this when creating a customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises) and not when creating a deprecated EMM-managed enterprise (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).
projectId: string, The ID of the Google Cloud Platform project which will own the enterprise.
signupUrlName: string, The name of the SignupUrl used to sign up for the enterprise. Set this when creating a customer-managed enterprise (https://developers.google.com/android/management/create-enterprise#customer-managed_enterprises) and not when creating a deprecated EMM-managed enterprise (https://developers.google.com/android/management/create-enterprise#emm-managed_enterprises).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
}

delete(name, x__xgafv=None)

Permanently deletes an enterprise and all accounts and data associated with it. Warning: this will result in a cascaded deletion of all AM API devices associated with the deleted enterprise. Only available for EMM-managed enterprises.

Args:
  name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets an enterprise.

Args:
name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
}

list(pageSize=None, pageToken=None, projectId=None, view=None, x__xgafv=None)

Lists EMM-managed enterprises. Only BASIC fields are returned.

Args:
pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value.
pageToken: string, A token identifying a page of results returned by the server.
projectId: string, Required. The Cloud project ID of the EMM managing the enterprises.
view: string, Specifies which Enterprise fields to return. This method only supports BASIC.
Allowed values
ENTERPRISE_VIEW_UNSPECIFIED - The API will default to the BASIC view for the List method.
BASIC - Includes name and enterprise_display_name fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to a request to list enterprises.
"enterprises": [ # The list of enterprises.
{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
},
],
"nextPageToken": "A String", # If there are more results, a token to retrieve next page of results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an enterprise. See also: SigninDetail

Args:
name: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
body: object, The request body.
The object takes the form of:

{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
}

updateMask: string, The field mask indicating the fields to update. If not set, all modifiable fields will be modified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The configuration applied to an enterprise.
"appAutoApprovalEnabled": True or False, # Deprecated and unused.
"contactInfo": { # Contact details for managed Google Play enterprises. # The enterprise contact info of an EMM-managed enterprise.
"contactEmail": "A String", # Email address for a point of contact, which will be used to send important announcements related to managed Google Play.
"dataProtectionOfficerEmail": "A String", # The email of the data protection officer. The email is validated but not verified.
"dataProtectionOfficerName": "A String", # The name of the data protection officer.
"dataProtectionOfficerPhone": "A String", # The phone number of the data protection officer The phone number is validated but not verified.
"euRepresentativeEmail": "A String", # The email of the EU representative. The email is validated but not verified.
"euRepresentativeName": "A String", # The name of the EU representative.
"euRepresentativePhone": "A String", # The phone number of the EU representative. The phone number is validated but not verified.
},
"enabledNotificationTypes": [ # The types of Google Pub/Sub notifications enabled for the enterprise.
"A String",
],
"enterpriseDisplayName": "A String", # The name of the enterprise displayed to users. This field has a maximum length of 100 characters.
"googleAuthenticationSettings": { # Contains settings for Google-provided user authentication. # Settings for Google-provided user authentication.
"googleAuthenticationRequired": "A String", # Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with signin_url In the case where Google authentication is required and a signin_url is specified, Google authentication will be launched before signin_url.
},
"logo": { # Data hosted at an external location. The data is to be downloaded by Android Device Policy and verified against the hash. # An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng.
"sha256Hash": "A String", # The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data.
"url": "A String", # The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL.
},
"name": "A String", # The name of the enterprise which is generated by the server during creation, in the form enterprises/{enterpriseId}.
"primaryColor": 42, # A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: (red << 16) | (green << 8) | blue, where the value of each component is between 0 and 255, inclusive.
"pubsubTopic": "A String", # The topic which Pub/Sub notifications are published to, in the form projects/{project}/topics/{topic}. This field is only required if Pub/Sub notifications are enabled.
"signinDetails": [ # Sign-in details of the enterprise.
{ # A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.
"allowPersonalUsage": "A String", # Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device.
"defaultStatus": "A String", # Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.
"qrCode": "A String", # A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.
"signinEnrollmentToken": "A String", # An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server.
"signinUrl": "A String", # Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.
"tokenTag": "A String", # An EMM-specified metadata to distinguish between instances of SigninDetail.
},
],
"termsAndConditions": [ # Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list.
{ # A terms and conditions page to be accepted during provisioning.
"content": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
"header": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A short header which appears above the HTML content.
"defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided.
"localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr.
"a_key": "A String",
},
},
},
],
}

Android Management API . enterprises

Instance Methods

Method Details