google_api_android_enterprise v0.16.1 GoogleApi.AndroidEnterprise.V1.Api.Users View Source
API calls for all endpoints tagged Users
.
Link to this section Summary
Functions
Deleted an EMM-managed user.
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.
Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.
Retrieves a user's details.
Retrieves the set of products a user is entitled to access.
Creates a new EMM-managed user.
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.
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.
Revokes a previously generated token (activation code) for the user.
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.
Updates the details of an EMM-managed user.
Link to this section Functions
androidenterprise_users_delete(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deleted an EMM-managed user.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
androidenterprise_users_generate_authentication_token(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_generate_authentication_token( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.AuthenticationToken.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.AuthenticationToken{}}
on success{:error, info}
on failure
androidenterprise_users_generate_token(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_generate_token( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.UserToken.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.
This call only works with Google managed accounts.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.UserToken{}}
on success{:error, info}
on failure
androidenterprise_users_get(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a user's details.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.User{}}
on success{:error, info}
on failure
androidenterprise_users_get_available_product_set(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_get_available_product_set( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductSet.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves the set of products a user is entitled to access.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductSet{}}
on success{:error, info}
on failure
androidenterprise_users_insert(connection, enterprise_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.AndroidEnterprise.V1.Model.User.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.User{}}
on success{:error, info}
on failure
androidenterprise_users_list(connection, enterprise_id, email, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.UsersListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.email
(type:String.t
) - The exact primary email address of the user to look up.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.UsersListResponse{}}
on success{:error, info}
on failure
androidenterprise_users_revoke_device_access(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_revoke_device_access( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
androidenterprise_users_revoke_token(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_revoke_token( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Revokes a previously generated token (activation code) for the user.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
androidenterprise_users_set_available_product_set(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_set_available_product_set( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.ProductSet.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.AndroidEnterprise.V1.Model.ProductSet.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.ProductSet{}}
on success{:error, info}
on failure
androidenterprise_users_update(connection, enterprise_id, user_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_users_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
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. Other fields must either be unset or have the currently active value.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.user_id
(type:String.t
) - The ID of the user.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.AndroidEnterprise.V1.Model.User.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.User{}}
on success{:error, info}
on failure