google_api_admin v0.11.0 GoogleApi.Admin.Directory_v1.Api.Roles View Source
API calls for all endpoints tagged Roles
.
Link to this section Summary
Functions
Deletes a role.
Retrieves a role.
Retrieves a paginated list of all the roles in a domain.
Updates a role. This method supports patch semantics.
Link to this section Functions
Link to this function
directory_roles_delete(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Sourcedirectory_roles_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a role.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.role_id
(type:String.t
) - Immutable ID of the role.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_roles_get(connection, customer, role_id, optional_params \\ [], opts \\ [])
View Sourcedirectory_roles_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a role.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.role_id
(type:String.t
) - Immutable ID of the role.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.Role{}}
on success{:error, info}
on failure
Link to this function
directory_roles_insert(connection, customer, optional_params \\ [], opts \\ [])
View Sourcedirectory_roles_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Creates a role.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.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.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 Sourcedirectory_roles_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Roles.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves a paginated list of all the roles in a domain.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.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.: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 Sourcedirectory_roles_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a role. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.role_id
(type:String.t
) - Immutable ID of the role.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.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 Sourcedirectory_roles_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a role.
Parameters
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to servercustomer
(type:String.t
) - Immutable ID of the G Suite account.role_id
(type:String.t
) - Immutable ID of the role.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.Role.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Admin.Directory_v1.Model.Role{}}
on success{:error, info}
on failure