View Source GoogleApi.Admin.Directory_v1.Api.Roles (google_api_admin v0.40.0)
API calls for all endpoints tagged Roles
.
Summary
Functions
Deletes a role.
Retrieves a role.
Retrieves a paginated list of all the roles in a domain.
Patches a role.
Functions
Link to this function
directory_roles_delete(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a role.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - Immutable ID of the Google Workspace account. -
role_id
(type:String.t
) - Immutable ID of the role. -
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_roles_get(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a role.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead ofdomain
. You can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. You must provide either thecustomer
or thedomain
parameter. -
role_id
(type:String.t
) - Immutable ID of the role. -
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.Role{}}
on success -
{:error, info}
on failure
Link to this function
directory_roles_insert(connection, customer, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a role.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - Immutable ID of the Google Workspace account. -
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.Role.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Role{}}
on success -
{:error, info}
on failure
Link to this function
directory_roles_list(connection, customer, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Roles.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a paginated list of all the roles in a domain.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead ofdomain
. You can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. You must provide either thecustomer
or thedomain
parameter. -
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"). -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:pageToken
(type:String.t
) - Token to specify the next page in the list.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Roles{}}
on success -
{:error, info}
on failure
Link to this function
directory_roles_patch(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Patches a role.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - Immutable ID of the Google Workspace account. -
role_id
(type:String.t
) - Immutable ID of the role. -
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.Role.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Role{}}
on success -
{:error, info}
on failure
Link to this function
directory_roles_update(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Source@spec directory_roles_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a role.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer
(type:String.t
) - Immutable ID of the Google Workspace account. -
role_id
(type:String.t
) - Immutable ID of the role. -
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.Role.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.Role{}}
on success -
{:error, info}
on failure