GoogleApi.CloudIdentity.V1.Api.Groups (google_api_cloud_identity v0.25.0) View Source
API calls for all endpoints tagged Groups
.
Link to this section Summary
Functions
Lists the Group
resources under a customer or namespace.
Looks up the resource name of a Group
by its EntityKey
.
Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.
Creates a Membership
.
Deletes a Membership
.
Retrieves a Membership
.
Get a membership graph of just a member or both a member and a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.
Lists the Membership
s within a Group
.
Looks up the resource name of a Membership
by its EntityKey
.
Modifies the MembershipRole
s of a Membership
.
Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
Searches for Group
resources matching a specified query.
Link to this section Functions
cloudidentity_groups_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Group.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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"). -
:initialGroupConfig
(type:String.t
) - Optional. The initial configuration option for theGroup
. -
:body
(type:GoogleApi.CloudIdentity.V1.Model.Group.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a Group
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of theGroup
to retrieve. Must be of the formgroups/{group}
. -
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.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Group.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a Group
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of theGroup
to retrieve. Must be of the formgroups/{group}
. -
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.CloudIdentity.V1.Model.Group{}}
on success -
{:error, info}
on failure
cloudidentity_groups_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ListGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Group
resources under a customer or namespace.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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"). -
:pageSize
(type:integer()
) - The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains anext_page_token
. If unspecified, defaults to 200 forView.BASIC
and to 50 forView.FULL
. Must not be greater than 1000 forView.BASIC
or 500 forView.FULL
. -
:pageToken
(type:String.t
) - Thenext_page_token
value returned from a previous list request, if any. -
:parent
(type:String.t
) - Required. The parent resource under which to list allGroup
resources. Must be of the formidentitysources/{identity_source}
for external- identity-mapped groups orcustomers/{customer}
for Google Groups. Thecustomer
must begin with "C" (for example, 'C046psxkn'). -
:view
(type:String.t
) - The level of detail to be returned. If unspecified, defaults toView.BASIC
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ListGroupsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_lookup(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_lookup(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.LookupGroupNameResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Looks up the resource name of a Group
by its EntityKey
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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"). -
:"groupKey.id"
(type:String.t
) - The ID of the entity. For Google-managed entities, theid
should be the email address of an existing group or user. For external-identity-mapped entities, theid
must be a string conforming to the Identity Source's requirements. Must be unique within anamespace
. -
:"groupKey.namespace"
(type:String.t
) - The namespace in which the entity exists. If not specified, theEntityKey
represents a Google-managed entity such as a Google user or a Google Group. If specified, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.LookupGroupNameResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_check_transitive_membership(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_check_transitive_membership( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.CheckTransitiveMembershipResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Resource name of the group to check the transitive membership in. Format:groups/{group}
, wheregroup
is the unique id assigned to the Group to which the Membership belongs to. -
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"). -
:query
(type:String.t
) - Required. A CEL expression that MUST include member specification. This is arequired
field. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query:member_key_id == 'member_key_id_value'
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.CheckTransitiveMembershipResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a Membership
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parentGroup
resource under which to create theMembership
. Must be of the formgroups/{group}
. -
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.CloudIdentity.V1.Model.Membership.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a Membership
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of theMembership
to delete. Must be of the formgroups/{group}/memberships/{membership}
-
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.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Membership.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a Membership
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of theMembership
to retrieve. Must be of the formgroups/{group}/memberships/{membership}
. -
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.CloudIdentity.V1.Model.Membership{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_get_membership_graph(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_get_membership_graph( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get a membership graph of just a member or both a member and a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the group to search transitive memberships in. Format:groups/{group}
, wheregroup
is the unique ID assigned to the Group to which the Membership belongs to. group can be a wildcard collection id "-". When a group is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned. -
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"). -
:query
(type:String.t
) - Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query:member_key_id == 'member_key_id_value' && in labels
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ListMembershipsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the Membership
s within a Group
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parentGroup
resource under which to lookup theMembership
name. Must be of the formgroups/{group}
. -
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"). -
:pageSize
(type:integer()
) - The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains anext_page_token
. If unspecified, defaults to 200 forGroupView.BASIC
and to 50 forGroupView.FULL
. Must not be greater than 1000 forGroupView.BASIC
or 500 forGroupView.FULL
. -
:pageToken
(type:String.t
) - Thenext_page_token
value returned from a previous search request, if any. -
:view
(type:String.t
) - The level of detail to be returned. If unspecified, defaults toView.BASIC
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ListMembershipsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_lookup(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_lookup( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.LookupMembershipNameResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Looks up the resource name of a Membership
by its EntityKey
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parentGroup
resource under which to lookup theMembership
name. Must be of the formgroups/{group}
. -
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"). -
:"memberKey.id"
(type:String.t
) - The ID of the entity. For Google-managed entities, theid
should be the email address of an existing group or user. For external-identity-mapped entities, theid
must be a string conforming to the Identity Source's requirements. Must be unique within anamespace
. -
:"memberKey.namespace"
(type:String.t
) - The namespace in which the entity exists. If not specified, theEntityKey
represents a Google-managed entity such as a Google user or a Google Group. If specified, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.LookupMembershipNameResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_modify_membership_roles(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_modify_membership_roles( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ModifyMembershipRolesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Modifies the MembershipRole
s of a Membership
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of theMembership
whose roles are to be modified. Must be of the formgroups/{group}/memberships/{membership}
. -
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.CloudIdentity.V1.Model.ModifyMembershipRolesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ModifyMembershipRolesResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_search_transitive_groups(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_search_transitive_groups( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.SearchTransitiveGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Resource name of the group to search transitive memberships in. Format:groups/{group}
, wheregroup
is always '-' as this API will search across all groups for a given member. -
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"). -
:pageSize
(type:integer()
) - The default page size is 200 (max 1000). -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request, if any. -
:query
(type:String.t
) - Required. A CEL expression that MUST include member specification AND label(s). This is arequired
field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both amember_key_id
and amember_key_namespace
, which requires an additional query input:member_key_namespace
. Example query:member_key_id == 'member_key_id_value' && in labels
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.SearchTransitiveGroupsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_memberships_search_transitive_memberships(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_memberships_search_transitive_memberships( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.SearchTransitiveMembershipsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Resource name of the group to search transitive memberships in. Format:groups/{group}
, wheregroup
is the unique ID assigned to the Group. -
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"). -
:pageSize
(type:integer()
) - The default page size is 200 (max 1000). -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous list request, if any.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.SearchTransitiveMembershipsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_groups_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a Group
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The resource name of theGroup
. Shall be of the formgroups/{group}
. -
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"). -
:updateMask
(type:String.t
) - Required. The names of fields to update. May only contain the following fields:display_name
,description
,labels
. -
:body
(type:GoogleApi.CloudIdentity.V1.Model.Group.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_groups_search(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_groups_search(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudIdentity.V1.Model.SearchGroupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Searches for Group
resources matching a specified query.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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"). -
:pageSize
(type:integer()
) - The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains anext_page_token
. If unspecified, defaults to 200 forGroupView.BASIC
and 50 forGroupView.FULL
. Must not be greater than 1000 forGroupView.BASIC
or 500 forGroupView.FULL
. -
:pageToken
(type:String.t
) - Thenext_page_token
value returned from a previous search request, if any. -
:query
(type:String.t
) - Required. The search query. Must be specified in Common Expression Language. May only contain equality operators on the parent and inclusion operators on labels (e.g.,parent == 'customers/{customer}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels
). Thecustomer
must begin with "C" (for example, 'C046psxkn'). -
:view
(type:String.t
) - The level of detail to be returned. If unspecified, defaults toView.BASIC
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.SearchGroupsResponse{}}
on success -
{:error, info}
on failure