View Source GoogleApi.Admin.Directory_v1.Api.Orgunits (google_api_admin v0.40.0)
API calls for all endpoints tagged Orgunits
.
Summary
Functions
directory_orgunits_delete(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
Removes an organizational unit.
Retrieves an organizational unit.
Adds an organizational unit.
Retrieves a list of all organizational units for an account.
Updates an organizational unit. This method supports patch semantics
directory_orgunits_update(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
Updates an organizational unit.
Functions
Link to this function
directory_orgunits_delete(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Removes an organizational unit.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
org_unit_path
(type:String.t
) - The full path of the organizational unit (minus the leading/
) or its unique ID. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
Link to this function
directory_orgunits_get(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves an organizational unit.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
org_unit_path
(type:String.t
) - The full path of the organizational unit (minus the leading/
) or its unique ID. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success -
{:error, info}
on failure
Link to this function
directory_orgunits_insert(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Adds an organizational unit.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Admin.Directory_v1.Model.OrgUnit.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success -
{:error, info}
on failure
Link to this function
directory_orgunits_list(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnits.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a list of all organizational units for an account.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:orgUnitPath
(type:String.t
) - The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit. -
:type
(type:String.t
) - Whether to return all sub-organizations or just immediate children.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnits{}}
on success -
{:error, info}
on failure
Link to this function
directory_orgunits_patch(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an organizational unit. This method supports patch semantics
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
org_unit_path
(type:String.t
) - The full path of the organizational unit (minus the leading/
) or its unique ID. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Admin.Directory_v1.Model.OrgUnit.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success -
{:error, info}
on failure
Link to this function
directory_orgunits_update(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Source@spec directory_orgunits_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an organizational unit.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
org_unit_path
(type:String.t
) - The full path of the organizational unit (minus the leading/
) or its unique ID. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
: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
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Admin.Directory_v1.Model.OrgUnit.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success -
{:error, info}
on failure