google_api_admin

v0.18.0

google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Api.Users View Source

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

directory_users_aliases_delete(connection, user_key, alias, optional_params \\ [], opts \\ [])

Remove a alias for the user

directory_users_aliases_insert(connection, user_key, optional_params \\ [], opts \\ [])

Add a alias for the user

directory_users_aliases_list(connection, user_key, optional_params \\ [], opts \\ [])

List all aliases for a user

directory_users_aliases_watch(connection, user_key, optional_params \\ [], opts \\ [])

Watch for changes in user aliases list

directory_users_delete(connection, user_key, optional_params \\ [], opts \\ [])

Delete user

directory_users_get(connection, user_key, optional_params \\ [], opts \\ [])

retrieve user

directory_users_insert(connection, optional_params \\ [], opts \\ [])

create user.

directory_users_list(connection, optional_params \\ [], opts \\ [])

Retrieve either deleted users or all users in a domain (paginated)

directory_users_make_admin(connection, user_key, optional_params \\ [], opts \\ [])

change admin status of a user

directory_users_patch(connection, user_key, optional_params \\ [], opts \\ [])

update user. This method supports patch semantics.

directory_users_photos_delete(connection, user_key, optional_params \\ [], opts \\ [])

Remove photos for the user

directory_users_photos_get(connection, user_key, optional_params \\ [], opts \\ [])

Retrieve photo of a user

directory_users_photos_patch(connection, user_key, optional_params \\ [], opts \\ [])

Add a photo for the user. This method supports patch semantics.

directory_users_photos_update(connection, user_key, optional_params \\ [], opts \\ [])

Add a photo for the user

directory_users_undelete(connection, user_key, optional_params \\ [], opts \\ [])

Undelete a deleted user

directory_users_update(connection, user_key, optional_params \\ [], opts \\ [])

update user

directory_users_watch(connection, optional_params \\ [], opts \\ [])

Watch for changes in users list

Link to this section Functions

Link to this function

directory_users_aliases_delete(connection, user_key, alias, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_aliases_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Remove a alias for the user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable ID of the user
  • alias (type: String.t) - The alias to be removed
  • 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
Link to this function

directory_users_aliases_insert(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_aliases_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Alias.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Add a alias for the user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.Admin.Directory_v1.Model.Alias.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Alias{}} on success
  • {:error, info} on failure
Link to this function

directory_users_aliases_list(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_aliases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Aliases.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

List all aliases for a user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.
    • :event (type: String.t) - Event on which subscription is intended (if subscribing)
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Aliases{}} on success
  • {:error, info} on failure
Link to this function

directory_users_aliases_watch(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_aliases_watch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Channel.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Watch for changes in user aliases list

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.
    • :event (type: String.t) - Event on which subscription is intended (if subscribing)
    • :resource (type: GoogleApi.Admin.Directory_v1.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Channel{}} on success
  • {:error, info} on failure
Link to this function

directory_users_delete(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Delete user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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
Link to this function

directory_users_get(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.User.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

retrieve user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.
    • :customFieldMask (type: String.t) - Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
    • :projection (type: String.t) - What subset of fields to fetch for this user.
    • :viewType (type: String.t) - Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.User{}} on success
  • {:error, info} on failure
Link to this function

directory_users_insert(connection, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.User.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

create user.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • 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.Admin.Directory_v1.Model.User.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.User{}} on success
  • {:error, info} on failure
Link to this function

directory_users_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Users.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieve either deleted users or all users in a domain (paginated)

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • 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.
    • :customFieldMask (type: String.t) - Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
    • :customer (type: String.t) - Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
    • :domain (type: String.t) - Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
    • :event (type: String.t) - Event on which subscription is intended (if subscribing)
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :orderBy (type: String.t) - Column to use for sorting results
    • :pageToken (type: String.t) - Token to specify next page in the list
    • :projection (type: String.t) - What subset of fields to fetch for this user.
    • :query (type: String.t) - Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
    • :showDeleted (type: String.t) - If set to true, retrieves the list of deleted users. (Default: false)
    • :sortOrder (type: String.t) - Whether to return results in ascending or descending order.
    • :viewType (type: String.t) - Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Users{}} on success
  • {:error, info} on failure
Link to this function

directory_users_make_admin(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_make_admin(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

change admin status of a user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable ID of the user as admin
  • 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.Admin.Directory_v1.Model.UserMakeAdmin.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

directory_users_patch(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.User.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

update user. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable ID of the user. If ID, it should match with id of user object
  • 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.Admin.Directory_v1.Model.User.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.User{}} on success
  • {:error, info} on failure
Link to this function

directory_users_photos_delete(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_photos_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Remove photos for the user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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
Link to this function

directory_users_photos_get(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_photos_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.UserPhoto.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieve photo of a user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.Admin.Directory_v1.Model.UserPhoto{}} on success
  • {:error, info} on failure
Link to this function

directory_users_photos_patch(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_photos_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.UserPhoto.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Add a photo for the user. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.Admin.Directory_v1.Model.UserPhoto.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.UserPhoto{}} on success
  • {:error, info} on failure
Link to this function

directory_users_photos_update(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_photos_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.UserPhoto.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Add a photo for the user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable 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.Admin.Directory_v1.Model.UserPhoto.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.UserPhoto{}} on success
  • {:error, info} on failure
Link to this function

directory_users_undelete(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_undelete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Undelete a deleted user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - The immutable 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.Admin.Directory_v1.Model.UserUndelete.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

directory_users_update(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.User.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

update user

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Email or immutable ID of the user. If ID, it should match with id of user object
  • 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.Admin.Directory_v1.Model.User.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.User{}} on success
  • {:error, info} on failure
Link to this function

directory_users_watch(connection, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_watch(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Channel.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Watch for changes in users list

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • 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.
    • :customFieldMask (type: String.t) - Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
    • :customer (type: String.t) - Immutable ID of the G Suite account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
    • :domain (type: String.t) - Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
    • :event (type: String.t) - Event on which subscription is intended (if subscribing)
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :orderBy (type: String.t) - Column to use for sorting results
    • :pageToken (type: String.t) - Token to specify next page in the list
    • :projection (type: String.t) - What subset of fields to fetch for this user.
    • :query (type: String.t) - Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
    • :showDeleted (type: String.t) - If set to true, retrieves the list of deleted users. (Default: false)
    • :sortOrder (type: String.t) - Whether to return results in ascending or descending order.
    • :viewType (type: String.t) - Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
    • :resource (type: GoogleApi.Admin.Directory_v1.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Channel{}} on success
  • {:error, info} on failure