google_api_admin v0.11.0 GoogleApi.Admin.Directory_v1.Api.Orgunits View Source
API calls for all endpoints tagged Orgunits
.
Link to this section Summary
Functions
Remove organizational unit
Retrieve organizational unit
Add organizational unit
Retrieve all organizational units
Update organizational unit. This method supports patch semantics.
Update organizational unit
Link to this section Functions
directory_orgunits_delete(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_delete( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Remove organizational unit
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountorg_unit_path
(type:list(String.t)
) - Full path of the organizational unit or its IDoptional_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
directory_orgunits_get(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_get( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieve organizational unit
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountorg_unit_path
(type:list(String.t)
) - Full path of the organizational unit or its IDoptional_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.OrgUnit{}}
on success{:error, info}
on failure
directory_orgunits_insert(connection, customer_id, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Add organizational unit
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountoptional_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.OrgUnit.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success{:error, info}
on failure
directory_orgunits_list(connection, customer_id, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnits.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieve all organizational units
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountoptional_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.:orgUnitPath
(type:String.t
) - the URL-encoded organizational unit's path or its ID: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
directory_orgunits_patch(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_patch( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Update organizational unit. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountorg_unit_path
(type:list(String.t)
) - Full path of the organizational unit or its IDoptional_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.OrgUnit.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success{:error, info}
on failure
directory_orgunits_update(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Sourcedirectory_orgunits_update( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.OrgUnit.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Update organizational unit
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer_id
(type:String.t
) - Immutable ID of the G Suite accountorg_unit_path
(type:list(String.t)
) - Full path of the organizational unit or its IDoptional_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.OrgUnit.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.OrgUnit{}}
on success{:error, info}
on failure