google_api_android_enterprise v0.0.1 GoogleApi.AndroidEnterprise.V1.Api.Entitlements View Source
API calls for all endpoints tagged Entitlements
.
Link to this section Summary
Functions
Removes an entitlement to an app for a user
Retrieves details of an entitlement
Lists all entitlements for the specified user. Only the ID is set
Adds or updates an entitlement to an app for a user. This method supports patch semantics
Adds or updates an entitlement to an app for a user
Link to this section Functions
androidenterprise_entitlements_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, nil} | {:error, Tesla.Env.t}
Removes an entitlement to an app for a user.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- user_id (String): The ID of the user.
- entitlement_id (String): The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %{}} on success {:error, info} on failure
androidenterprise_entitlements_get(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t} | {:error, Tesla.Env.t}
Retrieves details of an entitlement.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- user_id (String): The ID of the user.
- entitlement_id (String): The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Entitlement{}} on success {:error, info} on failure
androidenterprise_entitlements_list(Tesla.Env.client, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.EntitlementsListResponse.t} | {:error, Tesla.Env.t}
Lists all entitlements for the specified user. Only the ID is set.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- user_id (String): The ID of the user.
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.EntitlementsListResponse{}} on success {:error, info} on failure
androidenterprise_entitlements_patch(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t} | {:error, Tesla.Env.t}
Adds or updates an entitlement to an app for a user. This method supports patch semantics.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- user_id (String): The ID of the user.
- entitlement_id (String): The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :install (Boolean): Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
- :body (Entitlement):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Entitlement{}} on success {:error, info} on failure
androidenterprise_entitlements_update(Tesla.Env.client, String.t, String.t, String.t, keyword) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Entitlement.t} | {:error, Tesla.Env.t}
Adds or updates an entitlement to an app for a user.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String): The ID of the enterprise.
- user_id (String): The ID of the user.
- entitlement_id (String): The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm".
opts (KeywordList): [optional] Optional parameters
- :alt (String): Data format for the response.
- :fields (String): Selector specifying which fields to include in a partial response.
- :key (String): 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 (String): OAuth 2.0 token for the current user.
- :pretty_print (Boolean): Returns response with indentations and line breaks.
- :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
- :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- :install (Boolean): Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user.
- :body (Entitlement):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Entitlement{}} on success {:error, info} on failure