GoogleApi.CloudIdentity.V1.Api.Groups.cloudidentity_groups_lookup
You're seeing just the function
cloudidentity_groups_lookup
, go back to GoogleApi.CloudIdentity.V1.Api.Groups module for more information.
Link to this function
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_id}
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.LookupGroupNameResponse{}}
on success -
{:error, info}
on failure