cloudidentity

package
Version: v0.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 8

Documentation

Overview

Package cloudidentity provides access to the Cloud Identity API.

For product documentation, see: https://cloud.google.com/identity/

Creating a client

Usage example:

import "google.golang.org/api/cloudidentity/v1"
...
ctx := context.Background()
cloudidentityService, err := cloudidentity.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

cloudidentityService, err := cloudidentity.NewService(ctx, option.WithScopes(cloudidentity.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

cloudidentityService, err := cloudidentity.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudidentityService, err := cloudidentity.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See your device details
	CloudIdentityDevicesLookupScope = "https://www.googleapis.com/auth/cloud-identity.devices.lookup"

	// See, change, create, and delete any of the Cloud Identity Groups that
	// you can access, including the members of each group
	CloudIdentityGroupsScope = "https://www.googleapis.com/auth/cloud-identity.groups"

	// See any Cloud Identity Groups that you can access, including group
	// members and their emails
	CloudIdentityGroupsReadonlyScope = "https://www.googleapis.com/auth/cloud-identity.groups.readonly"

	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckTransitiveMembershipResponse added in v0.37.0

type CheckTransitiveMembershipResponse struct {
	// HasMembership: Response does not include the possible roles of a
	// member since the behavior of this rpc is not all-or-nothing unlike
	// the other rpcs. So, it may not be possible to list all the roles
	// definitively, due to possible lack of authorization in some of the
	// paths.
	HasMembership bool `json:"hasMembership,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "HasMembership") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "HasMembership") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CheckTransitiveMembershipResponse: The response message for MembershipsService.CheckTransitiveMembership.

func (*CheckTransitiveMembershipResponse) MarshalJSON added in v0.37.0

func (s *CheckTransitiveMembershipResponse) MarshalJSON() ([]byte, error)

type DevicesCancelWipeCall added in v0.32.0

type DevicesCancelWipeCall struct {
	// contains filtered or unexported fields
}

func (*DevicesCancelWipeCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesCancelWipeCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.cancelWipe" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesCancelWipeCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesCancelWipeCall) Header added in v0.32.0

func (c *DevicesCancelWipeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesCreateCall added in v0.32.0

type DevicesCreateCall struct {
	// contains filtered or unexported fields
}

func (*DevicesCreateCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesCreateCall) Customer added in v0.32.0

func (c *DevicesCreateCall) Customer(customer string) *DevicesCreateCall

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesCreateCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesCreateCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesCreateCall) Header added in v0.32.0

func (c *DevicesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeleteCall added in v0.32.0

type DevicesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeleteCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeleteCall) Customer added in v0.32.0

func (c *DevicesDeleteCall) Customer(customer string) *DevicesDeleteCall

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeleteCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeleteCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeleteCall) Header added in v0.32.0

func (c *DevicesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeviceUsersApproveCall added in v0.32.0

type DevicesDeviceUsersApproveCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersApproveCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersApproveCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.approve" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersApproveCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersApproveCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeviceUsersBlockCall added in v0.32.0

type DevicesDeviceUsersBlockCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersBlockCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersBlockCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.block" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersBlockCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersBlockCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeviceUsersCancelWipeCall added in v0.32.0

type DevicesDeviceUsersCancelWipeCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersCancelWipeCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersCancelWipeCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.cancelWipe" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersCancelWipeCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersCancelWipeCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeviceUsersClientStatesGetCall added in v0.32.0

type DevicesDeviceUsersClientStatesGetCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersClientStatesGetCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersClientStatesGetCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersClientStatesGetCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.clientStates.get" call. Exactly one of *GoogleAppsCloudidentityDevicesV1ClientState or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1ClientState.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersClientStatesGetCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersClientStatesGetCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersClientStatesGetCall) IfNoneMatch added in v0.32.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type DevicesDeviceUsersClientStatesListCall added in v0.32.0

type DevicesDeviceUsersClientStatesListCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersClientStatesListCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersClientStatesListCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersClientStatesListCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.clientStates.list" call. Exactly one of *GoogleAppsCloudidentityDevicesV1ListClientStatesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1ListClientStatesResponse.ServerRespon se.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersClientStatesListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersClientStatesListCall) Filter added in v0.32.0

Filter sets the optional parameter "filter": Additional restrictions when fetching list of client states.

func (*DevicesDeviceUsersClientStatesListCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersClientStatesListCall) IfNoneMatch added in v0.32.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*DevicesDeviceUsersClientStatesListCall) OrderBy added in v0.32.0

OrderBy sets the optional parameter "orderBy": Order specification for client states in the response.

func (*DevicesDeviceUsersClientStatesListCall) PageToken added in v0.32.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListClientStates` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClientStates` must match the call that provided the page token.

func (*DevicesDeviceUsersClientStatesListCall) Pages added in v0.32.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type DevicesDeviceUsersClientStatesPatchCall added in v0.32.0

type DevicesDeviceUsersClientStatesPatchCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersClientStatesPatchCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersClientStatesPatchCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersClientStatesPatchCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.clientStates.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersClientStatesPatchCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersClientStatesPatchCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersClientStatesPatchCall) UpdateMask added in v0.32.0

UpdateMask sets the optional parameter "updateMask": Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.

type DevicesDeviceUsersClientStatesService added in v0.32.0

type DevicesDeviceUsersClientStatesService struct {
	// contains filtered or unexported fields
}

func NewDevicesDeviceUsersClientStatesService added in v0.32.0

func NewDevicesDeviceUsersClientStatesService(s *Service) *DevicesDeviceUsersClientStatesService

func (*DevicesDeviceUsersClientStatesService) Get added in v0.32.0

Get: Gets the client state for the device user

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{part ner_id}`, where `device_id` is the unique ID assigned to the Device, `device_user_id` is the unique ID assigned to the User and `partner_id` identifies the partner storing the data. To get the client state for devices belonging to your own organization, the `partnerId` is in the format: `customerId-*anystring*`. Where the `customerId` is your organization's customer ID and `anystring` is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may use `my_customer` instead of the customer ID for devices managed by your own organization. You may specify `-` in place of the `{device_id}`, so the ClientState resource name can be: `devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partn er_id}`.

func (*DevicesDeviceUsersClientStatesService) List added in v0.32.0

List: Lists the client states for the given search query.

  • parent: To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}.

func (*DevicesDeviceUsersClientStatesService) Patch added in v0.32.0

Patch: Updates the client state for the device user **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

  • name: Output only. Resource name (https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partn er_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C').

type DevicesDeviceUsersDeleteCall added in v0.32.0

type DevicesDeviceUsersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersDeleteCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersDeleteCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersDeleteCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersDeleteCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersDeleteCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesDeviceUsersGetCall added in v0.32.0

type DevicesDeviceUsersGetCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersGetCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersGetCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersGetCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.get" call. Exactly one of *GoogleAppsCloudidentityDevicesV1DeviceUser or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1DeviceUser.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersGetCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersGetCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersGetCall) IfNoneMatch added in v0.32.0

func (c *DevicesDeviceUsersGetCall) IfNoneMatch(entityTag string) *DevicesDeviceUsersGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type DevicesDeviceUsersListCall added in v0.32.0

type DevicesDeviceUsersListCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersListCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersListCall) Customer added in v0.32.0

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesDeviceUsersListCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.list" call. Exactly one of *GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse.ServerRespons e.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersListCall) Filter added in v0.32.0

Filter sets the optional parameter "filter": Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields (https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.

func (*DevicesDeviceUsersListCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersListCall) IfNoneMatch added in v0.32.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*DevicesDeviceUsersListCall) OrderBy added in v0.32.0

OrderBy sets the optional parameter "orderBy": Order specification for devices in the response.

func (*DevicesDeviceUsersListCall) PageSize added in v0.32.0

PageSize sets the optional parameter "pageSize": The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

func (*DevicesDeviceUsersListCall) PageToken added in v0.32.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.

func (*DevicesDeviceUsersListCall) Pages added in v0.32.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type DevicesDeviceUsersLookupCall added in v0.32.0

type DevicesDeviceUsersLookupCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersLookupCall) AndroidId added in v0.32.0

AndroidId sets the optional parameter "androidId": Android Id returned by Settings.Secure#ANDROID_ID (https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID).

func (*DevicesDeviceUsersLookupCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersLookupCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.lookup" call. Exactly one of *GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse.ServerR esponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersLookupCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersLookupCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesDeviceUsersLookupCall) IfNoneMatch added in v0.32.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*DevicesDeviceUsersLookupCall) PageSize added in v0.32.0

PageSize sets the optional parameter "pageSize": The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.

func (*DevicesDeviceUsersLookupCall) PageToken added in v0.32.0

PageToken sets the optional parameter "pageToken": A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token.

func (*DevicesDeviceUsersLookupCall) Pages added in v0.32.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*DevicesDeviceUsersLookupCall) RawResourceId added in v0.32.0

func (c *DevicesDeviceUsersLookupCall) RawResourceId(rawResourceId string) *DevicesDeviceUsersLookupCall

RawResourceId sets the optional parameter "rawResourceId": Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json

func (*DevicesDeviceUsersLookupCall) UserId added in v0.32.0

UserId sets the optional parameter "userId": The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.

type DevicesDeviceUsersService added in v0.32.0

type DevicesDeviceUsersService struct {
	ClientStates *DevicesDeviceUsersClientStatesService
	// contains filtered or unexported fields
}

func NewDevicesDeviceUsersService added in v0.32.0

func NewDevicesDeviceUsersService(s *Service) *DevicesDeviceUsersService

func (*DevicesDeviceUsersService) Approve added in v0.32.0

func (r *DevicesDeviceUsersService) Approve(name string, googleappscloudidentitydevicesv1approvedeviceuserrequest *GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest) *DevicesDeviceUsersApproveCall

Approve: Approves device to access user data.

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

func (*DevicesDeviceUsersService) Block added in v0.32.0

func (r *DevicesDeviceUsersService) Block(name string, googleappscloudidentitydevicesv1blockdeviceuserrequest *GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest) *DevicesDeviceUsersBlockCall

Block: Blocks device from accessing user data

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

func (*DevicesDeviceUsersService) CancelWipe added in v0.32.0

func (r *DevicesDeviceUsersService) CancelWipe(name string, googleappscloudidentitydevicesv1cancelwipedeviceuserrequest *GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest) *DevicesDeviceUsersCancelWipeCall

CancelWipe: Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

func (*DevicesDeviceUsersService) Delete added in v0.32.0

Delete: Deletes the specified DeviceUser. This also revokes the user's access to device data.

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

func (*DevicesDeviceUsersService) Get added in v0.32.0

Get: Retrieves the specified DeviceUser

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

func (*DevicesDeviceUsersService) List added in v0.32.0

List: Lists/Searches DeviceUsers.

  • parent: To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device}.

func (*DevicesDeviceUsersService) Lookup added in v0.32.0

Lookup: Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

  • parent: Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user.

func (*DevicesDeviceUsersService) Wipe added in v0.32.0

func (r *DevicesDeviceUsersService) Wipe(name string, googleappscloudidentitydevicesv1wipedeviceuserrequest *GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest) *DevicesDeviceUsersWipeCall

Wipe: Wipes the user's account on a device. Other data on the device that is not associated with the user's work account is not affected. For example, if a Gmail app is installed on a device that is used for personal and work purposes, and the user is logged in to the Gmail app with their personal account as well as their work account, wiping the "deviceUser" by their work administrator will not affect their personal account within Gmail or other apps such as Photos.

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

type DevicesDeviceUsersWipeCall added in v0.32.0

type DevicesDeviceUsersWipeCall struct {
	// contains filtered or unexported fields
}

func (*DevicesDeviceUsersWipeCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesDeviceUsersWipeCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.deviceUsers.wipe" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesDeviceUsersWipeCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesDeviceUsersWipeCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DevicesGetCall added in v0.32.0

type DevicesGetCall struct {
	// contains filtered or unexported fields
}

func (*DevicesGetCall) Context added in v0.32.0

func (c *DevicesGetCall) Context(ctx context.Context) *DevicesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesGetCall) Customer added in v0.32.0

func (c *DevicesGetCall) Customer(customer string) *DevicesGetCall

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the Customer in the format: `customers/{customer_id}`, where customer_id is the customer to whom the device belongs. If you're using this API for your own organization, use `customers/my_customer`. If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesGetCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.get" call. Exactly one of *GoogleAppsCloudidentityDevicesV1Device or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1Device.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesGetCall) Fields added in v0.32.0

func (c *DevicesGetCall) Fields(s ...googleapi.Field) *DevicesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesGetCall) Header added in v0.32.0

func (c *DevicesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesGetCall) IfNoneMatch added in v0.32.0

func (c *DevicesGetCall) IfNoneMatch(entityTag string) *DevicesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type DevicesListCall added in v0.32.0

type DevicesListCall struct {
	// contains filtered or unexported fields
}

func (*DevicesListCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesListCall) Customer added in v0.32.0

func (c *DevicesListCall) Customer(customer string) *DevicesListCall

Customer sets the optional parameter "customer": Resource name (https://cloud.google.com/apis/design/resource_names) of the customer in the format: `customers/{customer_id}`, where customer_id is the customer to whom the device belongs. If you're using this API for your own organization, use `customers/my_customer`. If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesListCall) Do added in v0.32.0

Do executes the "cloudidentity.devices.list" call. Exactly one of *GoogleAppsCloudidentityDevicesV1ListDevicesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleAppsCloudidentityDevicesV1ListDevicesResponse.ServerResponse.He ader or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesListCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesListCall) Filter added in v0.32.0

func (c *DevicesListCall) Filter(filter string) *DevicesListCall

Filter sets the optional parameter "filter": Additional restrictions when fetching list of devices. For a list of search fields, refer to Mobile device search fields (https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.

func (*DevicesListCall) Header added in v0.32.0

func (c *DevicesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DevicesListCall) IfNoneMatch added in v0.32.0

func (c *DevicesListCall) IfNoneMatch(entityTag string) *DevicesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*DevicesListCall) OrderBy added in v0.32.0

func (c *DevicesListCall) OrderBy(orderBy string) *DevicesListCall

OrderBy sets the optional parameter "orderBy": Order specification for devices in the response. Only one of the following field names may be used to specify the order: `create_time`, `last_sync_time`, `model`, `os_version`, `device_type` and `serial_number`. `desc` may be specified optionally at the end to specify results to be sorted in descending order. Default order is ascending.

func (*DevicesListCall) PageSize added in v0.32.0

func (c *DevicesListCall) PageSize(pageSize int64) *DevicesListCall

PageSize sets the optional parameter "pageSize": The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100.

func (*DevicesListCall) PageToken added in v0.32.0

func (c *DevicesListCall) PageToken(pageToken string) *DevicesListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.

func (*DevicesListCall) Pages added in v0.32.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*DevicesListCall) View added in v0.32.0

func (c *DevicesListCall) View(view string) *DevicesListCall

View sets the optional parameter "view": The view to use for the List request.

Possible values:

"VIEW_UNSPECIFIED" - Default value. The value is unused.
"COMPANY_INVENTORY" - This view contains all devices imported by

the company admin. Each device in the response contains all information specified by the company admin when importing the device (i.e. asset tags). This includes devices that may be unaassigned or assigned to users.

"USER_ASSIGNED_DEVICES" - This view contains all devices with at

least one user registered on the device. Each device in the response contains all device information, except for asset tags.

type DevicesService added in v0.32.0

type DevicesService struct {
	DeviceUsers *DevicesDeviceUsersService
	// contains filtered or unexported fields
}

func NewDevicesService added in v0.32.0

func NewDevicesService(s *Service) *DevicesService

func (*DevicesService) CancelWipe added in v0.32.0

func (r *DevicesService) CancelWipe(name string, googleappscloudidentitydevicesv1cancelwipedevicerequest *GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest) *DevicesCancelWipeCall

CancelWipe: Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. This operation is possible when the device is in a "pending wipe" state. The device enters the "pending wipe" state when a wipe device command is issued, but has not yet been sent to the device. The cancel wipe will fail if the wipe command has already been issued to the device.

func (*DevicesService) Create added in v0.32.0

func (r *DevicesService) Create(googleappscloudidentitydevicesv1device *GoogleAppsCloudidentityDevicesV1Device) *DevicesCreateCall

Create: Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

func (*DevicesService) Delete added in v0.32.0

func (r *DevicesService) Delete(name string) *DevicesDeleteCall

Delete: Deletes the specified device.

func (*DevicesService) Get added in v0.32.0

func (r *DevicesService) Get(name string) *DevicesGetCall

Get: Retrieves the specified device.

func (*DevicesService) List added in v0.32.0

func (r *DevicesService) List() *DevicesListCall

List: Lists/Searches devices.

func (*DevicesService) Wipe added in v0.32.0

func (r *DevicesService) Wipe(name string, googleappscloudidentitydevicesv1wipedevicerequest *GoogleAppsCloudidentityDevicesV1WipeDeviceRequest) *DevicesWipeCall

Wipe: Wipes all data on the specified device.

  • name: Resource name (https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.

type DevicesWipeCall added in v0.32.0

type DevicesWipeCall struct {
	// contains filtered or unexported fields
}

func (*DevicesWipeCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DevicesWipeCall) Do added in v0.32.0

func (c *DevicesWipeCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudidentity.devices.wipe" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DevicesWipeCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DevicesWipeCall) Header added in v0.32.0

func (c *DevicesWipeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DynamicGroupMetadata added in v0.38.0

type DynamicGroupMetadata struct {
	// Queries: Memberships will be the union of all queries. Only one entry
	// with USER resource is currently supported. Customers can create up to
	// 100 dynamic groups.
	Queries []*DynamicGroupQuery `json:"queries,omitempty"`

	// Status: Output only. Status of the dynamic group.
	Status *DynamicGroupStatus `json:"status,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Queries") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Queries") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DynamicGroupMetadata: Dynamic group metadata like queries and status.

func (*DynamicGroupMetadata) MarshalJSON added in v0.38.0

func (s *DynamicGroupMetadata) MarshalJSON() ([]byte, error)

type DynamicGroupQuery added in v0.38.0

type DynamicGroupQuery struct {
	// Query: Query that determines the memberships of the dynamic group.
	// Examples: All users with at least one `organizations.department` of
	// engineering. `user.organizations.exists(org,
	// org.department=='engineering')` All users with at least one location
	// that has `area` of `foo` and `building_id` of `bar`.
	// `user.locations.exists(loc, loc.area=='foo' &&
	// loc.building_id=='bar')`
	Query string `json:"query,omitempty"`

	// ResourceType: Resource type for the Dynamic Group Query
	//
	// Possible values:
	//   "RESOURCE_TYPE_UNSPECIFIED" - Default value (not valid)
	//   "USER" - For queries on User
	ResourceType string `json:"resourceType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Query") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Query") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DynamicGroupQuery: Defines a query on a resource.

func (*DynamicGroupQuery) MarshalJSON added in v0.38.0

func (s *DynamicGroupQuery) MarshalJSON() ([]byte, error)

type DynamicGroupStatus added in v0.38.0

type DynamicGroupStatus struct {
	// Status: Status of the dynamic group.
	//
	// Possible values:
	//   "STATUS_UNSPECIFIED" - Default.
	//   "UP_TO_DATE" - The dynamic group is up-to-date.
	//   "UPDATING_MEMBERSHIPS" - The dynamic group has just been created
	// and memberships are being updated.
	Status string `json:"status,omitempty"`

	// StatusTime: The latest time at which the dynamic group is guaranteed
	// to be in the given status. If status is `UP_TO_DATE`, the latest time
	// at which the dynamic group was confirmed to be up-to-date. If status
	// is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was
	// created.
	StatusTime string `json:"statusTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Status") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Status") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DynamicGroupStatus: The current status of a dynamic group along with timestamp.

func (*DynamicGroupStatus) MarshalJSON added in v0.38.0

func (s *DynamicGroupStatus) MarshalJSON() ([]byte, error)

type EntityKey

type EntityKey struct {
	// Id: The ID of the entity. For Google-managed entities, the `id`
	// should be the email address of an existing group or user. For
	// external-identity-mapped entities, the `id` must be a string
	// conforming to the Identity Source's requirements. Must be unique
	// within a `namespace`.
	Id string `json:"id,omitempty"`

	// Namespace: The namespace in which the entity exists. If not
	// specified, the `EntityKey` represents a Google-managed entity such as
	// a Google user or a Google Group. If specified, the `EntityKey`
	// represents an external-identity-mapped group. The namespace must
	// correspond to an identity source created in Admin Console and must be
	// in the form of `identitysources/{identity_source_id}`.
	Namespace string `json:"namespace,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Id") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Id") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

EntityKey: A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s.

func (*EntityKey) MarshalJSON

func (s *EntityKey) MarshalJSON() ([]byte, error)

type ExpiryDetail added in v0.38.0

type ExpiryDetail struct {
	// ExpireTime: The time at which the `MembershipRole` will expire.
	ExpireTime string `json:"expireTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExpireTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExpireTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExpiryDetail: The `MembershipRole` expiry details.

func (*ExpiryDetail) MarshalJSON added in v0.38.0

func (s *ExpiryDetail) MarshalJSON() ([]byte, error)

type GetMembershipGraphResponse added in v0.37.0

type GetMembershipGraphResponse struct {
	// AdjacencyList: The membership graph's path information represented as
	// an adjacency list.
	AdjacencyList []*MembershipAdjacencyList `json:"adjacencyList,omitempty"`

	// Groups: The resources representing each group in the adjacency list.
	// Each group in this list can be correlated to a 'group' of the
	// MembershipAdjacencyList using the 'name' of the Group resource.
	Groups []*Group `json:"groups,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AdjacencyList") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AdjacencyList") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetMembershipGraphResponse: The response message for MembershipsService.GetMembershipGraph.

func (*GetMembershipGraphResponse) MarshalJSON added in v0.37.0

func (s *GetMembershipGraphResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1AndroidAttributes added in v0.31.0

type GoogleAppsCloudidentityDevicesV1AndroidAttributes struct {
	// EnabledUnknownSources: Whether applications from unknown sources can
	// be installed on device.
	EnabledUnknownSources bool `json:"enabledUnknownSources,omitempty"`

	// OwnerProfileAccount: Whether this account is on an owner/primary
	// profile. For phones, only true for owner profiles. Android 4+ devices
	// can have secondary or restricted user profiles.
	OwnerProfileAccount bool `json:"ownerProfileAccount,omitempty"`

	// OwnershipPrivilege: Ownership privileges on device.
	//
	// Possible values:
	//   "OWNERSHIP_PRIVILEGE_UNSPECIFIED" - Ownership privilege is not set.
	//   "DEVICE_ADMINISTRATOR" - Active device administrator privileges on
	// the device.
	//   "PROFILE_OWNER" - Profile Owner privileges. The account is in a
	// managed corporate profile.
	//   "DEVICE_OWNER" - Device Owner privileges on the device.
	OwnershipPrivilege string `json:"ownershipPrivilege,omitempty"`

	// SupportsWorkProfile: Whether device supports Android work profiles.
	// If false, this service will not block access to corp data even if an
	// administrator turns on the "Enforce Work Profile" policy.
	SupportsWorkProfile bool `json:"supportsWorkProfile,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "EnabledUnknownSources") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EnabledUnknownSources") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1AndroidAttributes: Resource representing the Android specific attributes of a Device.

func (*GoogleAppsCloudidentityDevicesV1AndroidAttributes) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest: Request message for approving the device to access user data.

func (*GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *GoogleAppsCloudidentityDevicesV1DeviceUser `json:"deviceUser,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceUser") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse: Response message for approving the device to access user data.

func (*GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest: Request message for blocking account on device.

func (*GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *GoogleAppsCloudidentityDevicesV1DeviceUser `json:"deviceUser,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceUser") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse: Response message for blocking the device from accessing user data.

func (*GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest: Request message for cancelling an unfinished device wipe.

func (*GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse struct {
	// Device: Resultant Device object for the action. Note that asset tags
	// will not be returned in the device object.
	Device *GoogleAppsCloudidentityDevicesV1Device `json:"device,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Device") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Device") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse: Response message for cancelling an unfinished device wipe.

func (*GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest: Request message for cancelling an unfinished user account wipe.

func (*GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *GoogleAppsCloudidentityDevicesV1DeviceUser `json:"deviceUser,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceUser") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse: Response message for cancelling an unfinished user account wipe.

func (*GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1ClientState added in v0.31.0

type GoogleAppsCloudidentityDevicesV1ClientState struct {
	// AssetTags: The caller can specify asset tags for this resource
	AssetTags []string `json:"assetTags,omitempty"`

	// ComplianceState: The compliance state of the resource as specified by
	// the API client.
	//
	// Possible values:
	//   "COMPLIANCE_STATE_UNSPECIFIED" - The compliance state of the
	// resource is unknown or unspecified.
	//   "COMPLIANT" - Device is compliant with third party policies
	//   "NON_COMPLIANT" - Device is not compliant with third party policies
	ComplianceState string `json:"complianceState,omitempty"`

	// CreateTime: Output only. The time the client state data was created.
	CreateTime string `json:"createTime,omitempty"`

	// CustomId: This field may be used to store a unique identifier for the
	// API resource within which these CustomAttributes are a field.
	CustomId string `json:"customId,omitempty"`

	// Etag: The token that needs to be passed back for concurrency control
	// in updates. Token needs to be passed back in UpdateRequest
	Etag string `json:"etag,omitempty"`

	// HealthScore: The Health score of the resource. The Health score is
	// the callers specification of the condition of the device from a
	// usability point of view. For example, a third-party device management
	// provider may specify a health score based on its compliance with
	// organizational policies.
	//
	// Possible values:
	//   "HEALTH_SCORE_UNSPECIFIED" - Default value
	//   "VERY_POOR" - The object is in very poor health as defined by the
	// caller.
	//   "POOR" - The object is in poor health as defined by the caller.
	//   "NEUTRAL" - The object health is neither good nor poor, as defined
	// by the caller.
	//   "GOOD" - The object is in good health as defined by the caller.
	//   "VERY_GOOD" - The object is in very good health as defined by the
	// caller.
	HealthScore string `json:"healthScore,omitempty"`

	// KeyValuePairs: The map of key-value attributes stored by callers
	// specific to a device. The total serialized length of this map may not
	// exceed 10KB. No limit is placed on the number of attributes in a map.
	KeyValuePairs map[string]GoogleAppsCloudidentityDevicesV1CustomAttributeValue `json:"keyValuePairs,omitempty"`

	// LastUpdateTime: Output only. The time the client state data was last
	// updated.
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`

	// Managed: The management state of the resource as specified by the API
	// client.
	//
	// Possible values:
	//   "MANAGED_STATE_UNSPECIFIED" - The management state of the resource
	// is unknown or unspecified.
	//   "MANAGED" - The resource is managed.
	//   "UNMANAGED" - The resource is not managed.
	Managed string `json:"managed,omitempty"`

	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// ClientState in format:
	// `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner
	// _id}`, where partner_id corresponds to the partner storing the data.
	// For partners belonging to the "BeyondCorp Alliance", this is the
	// partner ID specified to you by Google. For all other callers, this is
	// a string of the form: `{customer_id}-suffix`, where `customer_id` is
	// your customer ID. The *suffix* is any string the caller specifies.
	// This string will be displayed verbatim in the administration console.
	// This suffix is used in setting up Custom Access Levels in
	// Context-Aware Access. Your organization's customer ID can be obtained
	// from the URL: `GET
	// https://www.googleapis.com/admin/directory/v1/customers/my_customer`
	// The `id` field in the response contains the customer ID starting with
	// the letter 'C'. The customer ID to be used in this API is the string
	// after the letter 'C' (not including 'C')
	Name string `json:"name,omitempty"`

	// OwnerType: Output only. The owner of the ClientState
	//
	// Possible values:
	//   "OWNER_TYPE_UNSPECIFIED" - Unknown owner type
	//   "OWNER_TYPE_CUSTOMER" - Customer is the owner
	//   "OWNER_TYPE_PARTNER" - Partner is the owner
	OwnerType string `json:"ownerType,omitempty"`

	// ScoreReason: A descriptive cause of the health score.
	ScoreReason string `json:"scoreReason,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AssetTags") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AssetTags") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ClientState: Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users

func (*GoogleAppsCloudidentityDevicesV1ClientState) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CustomAttributeValue added in v0.31.0

type GoogleAppsCloudidentityDevicesV1CustomAttributeValue struct {
	// BoolValue: Represents a boolean value.
	BoolValue bool `json:"boolValue,omitempty"`

	// NumberValue: Represents a double value.
	NumberValue float64 `json:"numberValue,omitempty"`

	// StringValue: Represents a string value.
	StringValue string `json:"stringValue,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BoolValue") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BoolValue") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CustomAttributeValue: Additional custom attribute values may be one of these types

func (*GoogleAppsCloudidentityDevicesV1CustomAttributeValue) MarshalJSON added in v0.31.0

func (*GoogleAppsCloudidentityDevicesV1CustomAttributeValue) UnmarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1Device added in v0.31.0

type GoogleAppsCloudidentityDevicesV1Device struct {
	// AndroidSpecificAttributes: Output only. Attributes specific to
	// Android devices.
	AndroidSpecificAttributes *GoogleAppsCloudidentityDevicesV1AndroidAttributes `json:"androidSpecificAttributes,omitempty"`

	// AssetTag: Asset tag of the device.
	AssetTag string `json:"assetTag,omitempty"`

	// BasebandVersion: Output only. Baseband version of the device.
	BasebandVersion string `json:"basebandVersion,omitempty"`

	// BootloaderVersion: Output only. Device bootloader version. Example:
	// 0.6.7.
	BootloaderVersion string `json:"bootloaderVersion,omitempty"`

	// Brand: Output only. Device brand. Example: Samsung.
	Brand string `json:"brand,omitempty"`

	// BuildNumber: Output only. Build number of the device.
	BuildNumber string `json:"buildNumber,omitempty"`

	// CompromisedState: Output only. Represents whether the Device is
	// compromised.
	//
	// Possible values:
	//   "COMPROMISED_STATE_UNSPECIFIED" - Default value.
	//   "COMPROMISED" - The device is compromised (currently, this means
	// Android device is rooted).
	//   "UNCOMPROMISED" - The device is safe (currently, this means Android
	// device is unrooted).
	CompromisedState string `json:"compromisedState,omitempty"`

	// CreateTime: Output only. When the Company-Owned device was imported.
	// This field is empty for BYOD devices.
	CreateTime string `json:"createTime,omitempty"`

	// DeviceType: Output only. Type of device.
	//
	// Possible values:
	//   "DEVICE_TYPE_UNSPECIFIED" - Unknown device type
	//   "ANDROID" - Device is an Android device
	//   "IOS" - Device is an iOS device
	//   "GOOGLE_SYNC" - Device is a Google Sync device.
	//   "WINDOWS" - Device is a Windows device.
	//   "MAC_OS" - Device is a MacOS device.
	//   "LINUX" - Device is a Linux device.
	//   "CHROME_OS" - Device is a ChromeOS device.
	DeviceType string `json:"deviceType,omitempty"`

	// EnabledDeveloperOptions: Output only. Whether developer options is
	// enabled on device.
	EnabledDeveloperOptions bool `json:"enabledDeveloperOptions,omitempty"`

	// EnabledUsbDebugging: Output only. Whether USB debugging is enabled on
	// device.
	EnabledUsbDebugging bool `json:"enabledUsbDebugging,omitempty"`

	// EncryptionState: Output only. Device encryption state.
	//
	// Possible values:
	//   "ENCRYPTION_STATE_UNSPECIFIED" - Encryption Status is not set.
	//   "UNSUPPORTED_BY_DEVICE" - Device doesn't support encryption.
	//   "ENCRYPTED" - Device is encrypted.
	//   "NOT_ENCRYPTED" - Device is not encrypted.
	EncryptionState string `json:"encryptionState,omitempty"`

	// Imei: Output only. IMEI number of device if GSM device; empty
	// otherwise.
	Imei string `json:"imei,omitempty"`

	// KernelVersion: Output only. Kernel version of the device.
	KernelVersion string `json:"kernelVersion,omitempty"`

	// LastSyncTime: Most recent time when device synced with this service.
	LastSyncTime string `json:"lastSyncTime,omitempty"`

	// ManagementState: Output only. Management state of the device
	//
	// Possible values:
	//   "MANAGEMENT_STATE_UNSPECIFIED" - Default value. This value is
	// unused.
	//   "APPROVED" - Device is approved.
	//   "BLOCKED" - Device is blocked.
	//   "PENDING" - Device is pending approval.
	//   "UNPROVISIONED" - The device is not provisioned. Device will start
	// from this state until some action is taken (i.e. a user starts using
	// the device).
	//   "WIPING" - Data and settings on the device are being removed.
	//   "WIPED" - All data and settings on the device are removed.
	ManagementState string `json:"managementState,omitempty"`

	// Manufacturer: Output only. Device manufacturer. Example: Motorola.
	Manufacturer string `json:"manufacturer,omitempty"`

	// Meid: Output only. MEID number of device if CDMA device; empty
	// otherwise.
	Meid string `json:"meid,omitempty"`

	// Model: Output only. Model name of device. Example: Pixel 3.
	Model string `json:"model,omitempty"`

	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the Device
	// in format: `devices/{device_id}`, where device_id is the unique id
	// assigned to the Device.
	Name string `json:"name,omitempty"`

	// NetworkOperator: Output only. Mobile or network operator of device,
	// if available.
	NetworkOperator string `json:"networkOperator,omitempty"`

	// OsVersion: Output only. OS version of the device. Example: Android
	// 8.1.0.
	OsVersion string `json:"osVersion,omitempty"`

	// OtherAccounts: Output only. Domain name for Google accounts on
	// device. Type for other accounts on device. On Android, will only be
	// populated if |ownership_privilege| is |PROFILE_OWNER| or
	// |DEVICE_OWNER|. Does not include the account signed in to the device
	// policy app if that account's domain has only one account. Examples:
	// "com.example", "xyz.com".
	OtherAccounts []string `json:"otherAccounts,omitempty"`

	// OwnerType: Output only. Whether the device is owned by the company or
	// an individual
	//
	// Possible values:
	//   "DEVICE_OWNERSHIP_UNSPECIFIED" - Default value. The value is
	// unused.
	//   "COMPANY" - Company owns the device.
	//   "BYOD" - Bring Your Own Device (i.e. individual owns the device)
	OwnerType string `json:"ownerType,omitempty"`

	// ReleaseVersion: Output only. OS release version. Example: 6.0.
	ReleaseVersion string `json:"releaseVersion,omitempty"`

	// SecurityPatchTime: Output only. OS security patch update time on
	// device.
	SecurityPatchTime string `json:"securityPatchTime,omitempty"`

	// SerialNumber: Serial Number of device. Example: HT82V1A01076.
	SerialNumber string `json:"serialNumber,omitempty"`

	// WifiMacAddresses: WiFi MAC addresses of device.
	WifiMacAddresses []string `json:"wifiMacAddresses,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "AndroidSpecificAttributes") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "AndroidSpecificAttributes") to include in API requests with the JSON
	// null value. By default, fields with empty values are omitted from API
	// requests. However, any field with an empty value appearing in
	// NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1Device: A Device within the Cloud Identity Devices API. Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user.

func (*GoogleAppsCloudidentityDevicesV1Device) MarshalJSON added in v0.31.0

func (s *GoogleAppsCloudidentityDevicesV1Device) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1DeviceUser added in v0.31.0

type GoogleAppsCloudidentityDevicesV1DeviceUser struct {
	// CompromisedState: Compromised State of the DeviceUser object
	//
	// Possible values:
	//   "COMPROMISED_STATE_UNSPECIFIED" - Compromised state of Device User
	// account is unknown or unspecified.
	//   "COMPROMISED" - Device User Account is compromised.
	//   "NOT_COMPROMISED" - Device User Account is not compromised.
	CompromisedState string `json:"compromisedState,omitempty"`

	// CreateTime: When the user first signed in to the device
	CreateTime string `json:"createTime,omitempty"`

	// FirstSyncTime: Output only. Most recent time when user registered
	// with this service.
	FirstSyncTime string `json:"firstSyncTime,omitempty"`

	// LanguageCode: Output only. Default locale used on device, in IETF
	// BCP-47 format.
	LanguageCode string `json:"languageCode,omitempty"`

	// LastSyncTime: Output only. Last time when user synced with policies.
	LastSyncTime string `json:"lastSyncTime,omitempty"`

	// ManagementState: Output only. Management state of the user on the
	// device.
	//
	// Possible values:
	//   "MANAGEMENT_STATE_UNSPECIFIED" - Default value. This value is
	// unused.
	//   "WIPING" - This user's data and profile is being removed from the
	// device.
	//   "WIPED" - This user's data and profile is removed from the device.
	//   "APPROVED" - User is approved to access data on the device.
	//   "BLOCKED" - User is blocked from accessing data on the device.
	//   "PENDING_APPROVAL" - User is awaiting approval.
	//   "UNENROLLED" - User is unenrolled from Advanced Windows Management,
	// but the Windows account is still intact.
	ManagementState string `json:"managementState,omitempty"`

	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// DeviceUser in format:
	// `devices/{device_id}/deviceUsers/{device_user_id}`, where
	// `device_user_id` uniquely identifies a user's use of a device.
	Name string `json:"name,omitempty"`

	// PasswordState: Password state of the DeviceUser object
	//
	// Possible values:
	//   "PASSWORD_STATE_UNSPECIFIED" - Password state not set.
	//   "PASSWORD_SET" - Password set in object.
	//   "PASSWORD_NOT_SET" - Password not set in object.
	PasswordState string `json:"passwordState,omitempty"`

	// UserAgent: Output only. User agent on the device for this specific
	// user
	UserAgent string `json:"userAgent,omitempty"`

	// UserEmail: Email address of the user registered on the device.
	UserEmail string `json:"userEmail,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CompromisedState") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CompromisedState") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1DeviceUser: Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device

func (*GoogleAppsCloudidentityDevicesV1DeviceUser) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1ListClientStatesResponse added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ListClientStatesResponse struct {
	// ClientStates: Client states meeting the list restrictions.
	ClientStates []*GoogleAppsCloudidentityDevicesV1ClientState `json:"clientStates,omitempty"`

	// NextPageToken: Token to retrieve the next page of results. Empty if
	// there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ClientStates") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ClientStates") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ListClientStatesResponse: Response message that is returned in ListClientStates.

func (*GoogleAppsCloudidentityDevicesV1ListClientStatesResponse) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse struct {
	// DeviceUsers: Devices meeting the list restrictions.
	DeviceUsers []*GoogleAppsCloudidentityDevicesV1DeviceUser `json:"deviceUsers,omitempty"`

	// NextPageToken: Token to retrieve the next page of results. Empty if
	// there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DeviceUsers") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceUsers") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse: Response message that is returned from the ListDeviceUsers method.

func (*GoogleAppsCloudidentityDevicesV1ListDeviceUsersResponse) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ListDevicesResponse added in v0.32.0

type GoogleAppsCloudidentityDevicesV1ListDevicesResponse struct {
	// Devices: Devices meeting the list restrictions.
	Devices []*GoogleAppsCloudidentityDevicesV1Device `json:"devices,omitempty"`

	// NextPageToken: Token to retrieve the next page of results. Empty if
	// there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Devices") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Devices") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1ListDevicesResponse: Response message that is returned from the ListDevices method.

func (*GoogleAppsCloudidentityDevicesV1ListDevicesResponse) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse added in v0.32.0

type GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse struct {
	// Customer: The obfuscated customer Id that may be passed back to other
	// Devices API methods such as List, Get, etc.
	Customer string `json:"customer,omitempty"`

	// Names: Resource names
	// (https://cloud.google.com/apis/design/resource_names) of the
	// DeviceUsers in the format:
	// `devices/{device_id}/deviceUsers/{user_resource_id}`, where device_id
	// is the unique ID assigned to a Device and user_resource_id is the
	// unique user ID
	Names []string `json:"names,omitempty"`

	// NextPageToken: Token to retrieve the next page of results. Empty if
	// there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse: Response containing resource names of the DeviceUsers associated with the caller's credentials.

func (*GoogleAppsCloudidentityDevicesV1LookupSelfDeviceUsersResponse) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1WipeDeviceRequest: Request message for wiping all data on the device.

func (*GoogleAppsCloudidentityDevicesV1WipeDeviceRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceResponse struct {
	// Device: Resultant Device object for the action. Note that asset tags
	// will not be returned in the device object.
	Device *GoogleAppsCloudidentityDevicesV1Device `json:"device,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Device") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Device") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1WipeDeviceResponse: Response message for wiping all data on the device.

func (*GoogleAppsCloudidentityDevicesV1WipeDeviceResponse) MarshalJSON added in v0.31.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest added in v0.32.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest struct {
	// Customer: Optional. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// customer. If you're using this API for your own organization, use
	// `customers/my_customer` If you're using this API to manage another
	// organization, use `customers/{customer_id}`, where customer_id is the
	// customer to whom the device belongs.
	Customer string `json:"customer,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Customer") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest: Request message for starting an account wipe on device.

func (*GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest) MarshalJSON added in v0.32.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse added in v0.31.0

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *GoogleAppsCloudidentityDevicesV1DeviceUser `json:"deviceUser,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceUser") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse: Response message for wiping the user's account from the device.

func (*GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse) MarshalJSON added in v0.31.0

type Group

type Group struct {
	// CreateTime: Output only. The time when the `Group` was created.
	CreateTime string `json:"createTime,omitempty"`

	// Description: An extended description to help users determine the
	// purpose of a `Group`. Must not be longer than 4,096 characters.
	Description string `json:"description,omitempty"`

	// DisplayName: The display name of the `Group`.
	DisplayName string `json:"displayName,omitempty"`

	// DynamicGroupMetadata: Optional. Dynamic group metadata like queries
	// and status.
	DynamicGroupMetadata *DynamicGroupMetadata `json:"dynamicGroupMetadata,omitempty"`

	// GroupKey: Required. Immutable. The `EntityKey` of the `Group`.
	GroupKey *EntityKey `json:"groupKey,omitempty"`

	// Labels: Required. One or more label entries that apply to the Group.
	// Currently supported labels contain a key with an empty value. Google
	// Groups are the default type of group and have a label with a key of
	// `cloudidentity.googleapis.com/groups.discussion_forum` and an empty
	// value. Existing Google Groups can have an additional label with a key
	// of `cloudidentity.googleapis.com/groups.security` and an empty value
	// added to them. **This is an immutable change and the security label
	// cannot be removed once added.** Dynamic groups have a label with a
	// key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped
	// groups for Cloud Search have a label with a key of
	// `system/groups/external` and an empty value.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the `Group`.
	// Shall be of the form `groups/{group_id}`.
	Name string `json:"name,omitempty"`

	// Parent: Required. Immutable. The resource name of the entity under
	// which this `Group` resides in the Cloud Identity resource hierarchy.
	// Must be of the form `identitysources/{identity_source_id}` for
	// external- identity-mapped groups or `customers/{customer_id}` for
	// Google Groups. The `customer_id` must begin with "C" (for example,
	// 'C046psxkn').
	Parent string `json:"parent,omitempty"`

	// UpdateTime: Output only. The time when the `Group` was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Group: A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.

func (*Group) MarshalJSON

func (s *Group) MarshalJSON() ([]byte, error)

type GroupRelation added in v0.37.0

type GroupRelation struct {
	// DisplayName: Display name for this group.
	DisplayName string `json:"displayName,omitempty"`

	// Group: Resource name for this group.
	Group string `json:"group,omitempty"`

	// GroupKey: Entity key has an id and a namespace. In case of discussion
	// forums, the id will be an email address without a namespace.
	GroupKey *EntityKey `json:"groupKey,omitempty"`

	// Labels: Labels for Group resource.
	Labels map[string]string `json:"labels,omitempty"`

	// RelationType: The relation between the member and the transitive
	// group.
	//
	// Possible values:
	//   "RELATION_TYPE_UNSPECIFIED" - The relation type is undefined or
	// undetermined.
	//   "DIRECT" - The two entities have only a direct membership with each
	// other.
	//   "INDIRECT" - The two entities have only an indirect membership with
	// each other.
	//   "DIRECT_AND_INDIRECT" - The two entities have both a direct and an
	// indirect membership with each other.
	RelationType string `json:"relationType,omitempty"`

	// Roles: Membership roles of the member for the group.
	Roles []*TransitiveMembershipRole `json:"roles,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GroupRelation: Message representing a transitive group of a user or a group.

func (*GroupRelation) MarshalJSON added in v0.37.0

func (s *GroupRelation) MarshalJSON() ([]byte, error)

type GroupsCreateCall

type GroupsCreateCall struct {
	// contains filtered or unexported fields
}

func (*GroupsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsCreateCall) Do

Do executes the "cloudidentity.groups.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsCreateCall) Header

func (c *GroupsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsCreateCall) InitialGroupConfig added in v0.33.0

func (c *GroupsCreateCall) InitialGroupConfig(initialGroupConfig string) *GroupsCreateCall

InitialGroupConfig sets the optional parameter "initialGroupConfig": The initial configuration option for the `Group`.

Possible values:

"INITIAL_GROUP_CONFIG_UNSPECIFIED" - Default. Should not be used.
"WITH_INITIAL_OWNER" - The end user making the request will be

added as the initial owner of the `Group`.

"EMPTY" - An empty group is created without any initial owners.

This can only be used by admins of the domain.

type GroupsDeleteCall

type GroupsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*GroupsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsDeleteCall) Do

Do executes the "cloudidentity.groups.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsDeleteCall) Header

func (c *GroupsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsGetCall

type GroupsGetCall struct {
	// contains filtered or unexported fields
}

func (*GroupsGetCall) Context

func (c *GroupsGetCall) Context(ctx context.Context) *GroupsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsGetCall) Do

func (c *GroupsGetCall) Do(opts ...googleapi.CallOption) (*Group, error)

Do executes the "cloudidentity.groups.get" call. Exactly one of *Group or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Group.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsGetCall) Fields

func (c *GroupsGetCall) Fields(s ...googleapi.Field) *GroupsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsGetCall) Header

func (c *GroupsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsGetCall) IfNoneMatch

func (c *GroupsGetCall) IfNoneMatch(entityTag string) *GroupsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsListCall

type GroupsListCall struct {
	// contains filtered or unexported fields
}

func (*GroupsListCall) Context

func (c *GroupsListCall) Context(ctx context.Context) *GroupsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsListCall) Do

Do executes the "cloudidentity.groups.list" call. Exactly one of *ListGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsListCall) Fields

func (c *GroupsListCall) Fields(s ...googleapi.Field) *GroupsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsListCall) Header

func (c *GroupsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsListCall) IfNoneMatch

func (c *GroupsListCall) IfNoneMatch(entityTag string) *GroupsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsListCall) PageSize

func (c *GroupsListCall) PageSize(pageSize int64) *GroupsListCall

PageSize sets the optional parameter "pageSize": 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 a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.

func (*GroupsListCall) PageToken

func (c *GroupsListCall) PageToken(pageToken string) *GroupsListCall

PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous list request, if any.

func (*GroupsListCall) Pages

func (c *GroupsListCall) Pages(ctx context.Context, f func(*ListGroupsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*GroupsListCall) Parent

func (c *GroupsListCall) Parent(parent string) *GroupsListCall

Parent sets the optional parameter "parent": Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').

func (*GroupsListCall) View

func (c *GroupsListCall) View(view string) *GroupsListCall

View sets the optional parameter "view": The level of detail to be returned. If unspecified, defaults to `View.BASIC`.

Possible values:

"VIEW_UNSPECIFIED" - Default. Should not be used.
"BASIC" - Only basic resource information is returned.
"FULL" - All resource information is returned.

type GroupsLookupCall

type GroupsLookupCall struct {
	// contains filtered or unexported fields
}

func (*GroupsLookupCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsLookupCall) Do

Do executes the "cloudidentity.groups.lookup" call. Exactly one of *LookupGroupNameResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LookupGroupNameResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsLookupCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsLookupCall) GroupKeyId

func (c *GroupsLookupCall) GroupKeyId(groupKeyId string) *GroupsLookupCall

GroupKeyId sets the optional parameter "groupKey.id": The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.

func (*GroupsLookupCall) GroupKeyNamespace

func (c *GroupsLookupCall) GroupKeyNamespace(groupKeyNamespace string) *GroupsLookupCall

GroupKeyNamespace sets the optional parameter "groupKey.namespace": The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.

func (*GroupsLookupCall) Header

func (c *GroupsLookupCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsLookupCall) IfNoneMatch

func (c *GroupsLookupCall) IfNoneMatch(entityTag string) *GroupsLookupCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsMembershipsCheckTransitiveMembershipCall added in v0.37.0

type GroupsMembershipsCheckTransitiveMembershipCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsCheckTransitiveMembershipCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Do added in v0.37.0

Do executes the "cloudidentity.groups.memberships.checkTransitiveMembership" call. Exactly one of *CheckTransitiveMembershipResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CheckTransitiveMembershipResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Header added in v0.37.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsCheckTransitiveMembershipCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Query added in v0.37.0

Query sets the optional parameter "query": Required. A CEL expression that MUST include member specification. This is a `required` 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'`

type GroupsMembershipsCreateCall

type GroupsMembershipsCreateCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsCreateCall) Do

Do executes the "cloudidentity.groups.memberships.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembershipsDeleteCall

type GroupsMembershipsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsDeleteCall) Do

Do executes the "cloudidentity.groups.memberships.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembershipsGetCall

type GroupsMembershipsGetCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsGetCall) Do

Do executes the "cloudidentity.groups.memberships.get" call. Exactly one of *Membership or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Membership.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsGetCall) Header

func (c *GroupsMembershipsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsGetCall) IfNoneMatch

func (c *GroupsMembershipsGetCall) IfNoneMatch(entityTag string) *GroupsMembershipsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type GroupsMembershipsGetMembershipGraphCall added in v0.37.0

type GroupsMembershipsGetMembershipGraphCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsGetMembershipGraphCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsGetMembershipGraphCall) Do added in v0.37.0

Do executes the "cloudidentity.groups.memberships.getMembershipGraph" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsGetMembershipGraphCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsGetMembershipGraphCall) Header added in v0.37.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsGetMembershipGraphCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsGetMembershipGraphCall) Query added in v0.37.0

Query sets the optional parameter "query": 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`

type GroupsMembershipsListCall

type GroupsMembershipsListCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsListCall) Do

Do executes the "cloudidentity.groups.memberships.list" call. Exactly one of *ListMembershipsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMembershipsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsListCall) IfNoneMatch

func (c *GroupsMembershipsListCall) IfNoneMatch(entityTag string) *GroupsMembershipsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsListCall) PageSize

PageSize sets the optional parameter "pageSize": 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 a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.

func (*GroupsMembershipsListCall) PageToken

PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous search request, if any.

func (*GroupsMembershipsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*GroupsMembershipsListCall) View

View sets the optional parameter "view": The level of detail to be returned. If unspecified, defaults to `View.BASIC`.

Possible values:

"VIEW_UNSPECIFIED" - Default. Should not be used.
"BASIC" - Only basic resource information is returned.
"FULL" - All resource information is returned.

type GroupsMembershipsLookupCall

type GroupsMembershipsLookupCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsLookupCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsLookupCall) Do

Do executes the "cloudidentity.groups.memberships.lookup" call. Exactly one of *LookupMembershipNameResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *LookupMembershipNameResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsLookupCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsLookupCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsLookupCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsLookupCall) MemberKeyId

func (c *GroupsMembershipsLookupCall) MemberKeyId(memberKeyId string) *GroupsMembershipsLookupCall

MemberKeyId sets the optional parameter "memberKey.id": The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`.

func (*GroupsMembershipsLookupCall) MemberKeyNamespace

func (c *GroupsMembershipsLookupCall) MemberKeyNamespace(memberKeyNamespace string) *GroupsMembershipsLookupCall

MemberKeyNamespace sets the optional parameter "memberKey.namespace": The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.

type GroupsMembershipsModifyMembershipRolesCall added in v0.33.0

type GroupsMembershipsModifyMembershipRolesCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsModifyMembershipRolesCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsModifyMembershipRolesCall) Do added in v0.33.0

Do executes the "cloudidentity.groups.memberships.modifyMembershipRoles" call. Exactly one of *ModifyMembershipRolesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ModifyMembershipRolesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsModifyMembershipRolesCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsModifyMembershipRolesCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type GroupsMembershipsSearchTransitiveGroupsCall added in v0.37.0

type GroupsMembershipsSearchTransitiveGroupsCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsSearchTransitiveGroupsCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Do added in v0.37.0

Do executes the "cloudidentity.groups.memberships.searchTransitiveGroups" call. Exactly one of *SearchTransitiveGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchTransitiveGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Header added in v0.37.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsSearchTransitiveGroupsCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsSearchTransitiveGroupsCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The default page size is 200 (max 1000).

func (*GroupsMembershipsSearchTransitiveGroupsCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list request, if any.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Query added in v0.37.0

Query sets the optional parameter "query": Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped 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`

type GroupsMembershipsSearchTransitiveMembershipsCall added in v0.37.0

type GroupsMembershipsSearchTransitiveMembershipsCall struct {
	// contains filtered or unexported fields
}

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Do added in v0.37.0

Do executes the "cloudidentity.groups.memberships.searchTransitiveMemberships" call. Exactly one of *SearchTransitiveMembershipsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchTransitiveMembershipsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Header added in v0.37.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The default page size is 200 (max 1000).

func (*GroupsMembershipsSearchTransitiveMembershipsCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous list request, if any.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type GroupsMembershipsService

type GroupsMembershipsService struct {
	// contains filtered or unexported fields
}

func NewGroupsMembershipsService

func NewGroupsMembershipsService(s *Service) *GroupsMembershipsService

func (*GroupsMembershipsService) CheckTransitiveMembership added in v0.37.0

CheckTransitiveMembership: 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.

func (*GroupsMembershipsService) Create

Create: Creates a `Membership`.

  • parent: The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`.

func (*GroupsMembershipsService) Delete

Delete: Deletes a `Membership`.

func (*GroupsMembershipsService) Get

Get: Retrieves a `Membership`.

func (*GroupsMembershipsService) GetMembershipGraph added in v0.37.0

GetMembershipGraph: 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.

  • parent: Resource name (https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id "-". When a group_id 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.

func (*GroupsMembershipsService) List

List: Lists the `Membership`s within a `Group`.

  • parent: The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`.

func (*GroupsMembershipsService) Lookup

Lookup: Looks up the resource name (https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`.

  • parent: The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`.

func (*GroupsMembershipsService) ModifyMembershipRoles added in v0.33.0

func (r *GroupsMembershipsService) ModifyMembershipRoles(name string, modifymembershiprolesrequest *ModifyMembershipRolesRequest) *GroupsMembershipsModifyMembershipRolesCall

ModifyMembershipRoles: Modifies the `MembershipRole`s of a `Membership`.

func (*GroupsMembershipsService) SearchTransitiveGroups added in v0.37.0

SearchTransitiveGroups: 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.

func (*GroupsMembershipsService) SearchTransitiveMemberships added in v0.37.0

SearchTransitiveMemberships: 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.

type GroupsPatchCall

type GroupsPatchCall struct {
	// contains filtered or unexported fields
}

func (*GroupsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsPatchCall) Do

func (c *GroupsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudidentity.groups.patch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsPatchCall) Header

func (c *GroupsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsPatchCall) UpdateMask

func (c *GroupsPatchCall) UpdateMask(updateMask string) *GroupsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. The names of fields to update. May only contain the following fields: `display_name`, `description`, `labels`.

type GroupsSearchCall

type GroupsSearchCall struct {
	// contains filtered or unexported fields
}

func (*GroupsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*GroupsSearchCall) Do

Do executes the "cloudidentity.groups.search" call. Exactly one of *SearchGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*GroupsSearchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*GroupsSearchCall) Header

func (c *GroupsSearchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*GroupsSearchCall) IfNoneMatch

func (c *GroupsSearchCall) IfNoneMatch(entityTag string) *GroupsSearchCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*GroupsSearchCall) PageSize

func (c *GroupsSearchCall) PageSize(pageSize int64) *GroupsSearchCall

PageSize sets the optional parameter "pageSize": 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 a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.

func (*GroupsSearchCall) PageToken

func (c *GroupsSearchCall) PageToken(pageToken string) *GroupsSearchCall

PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous search request, if any.

func (*GroupsSearchCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*GroupsSearchCall) Query

func (c *GroupsSearchCall) Query(query string) *GroupsSearchCall

Query sets the optional parameter "query": Required. The search query. Must be specified in Common Expression Language (https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer_id` must begin with "C" (for example, 'C046psxkn').

func (*GroupsSearchCall) View

func (c *GroupsSearchCall) View(view string) *GroupsSearchCall

View sets the optional parameter "view": The level of detail to be returned. If unspecified, defaults to `View.BASIC`.

Possible values:

"VIEW_UNSPECIFIED" - Default. Should not be used.
"BASIC" - Only basic resource information is returned.
"FULL" - All resource information is returned.

type GroupsService

type GroupsService struct {
	Memberships *GroupsMembershipsService
	// contains filtered or unexported fields
}

func NewGroupsService

func NewGroupsService(s *Service) *GroupsService

func (*GroupsService) Create

func (r *GroupsService) Create(group *Group) *GroupsCreateCall

Create: Creates a Group.

func (*GroupsService) Delete

func (r *GroupsService) Delete(name string) *GroupsDeleteCall

Delete: Deletes a `Group`.

func (*GroupsService) Get

func (r *GroupsService) Get(name string) *GroupsGetCall

Get: Retrieves a `Group`.

func (*GroupsService) List

func (r *GroupsService) List() *GroupsListCall

List: Lists the `Group` resources under a customer or namespace.

func (*GroupsService) Lookup

func (r *GroupsService) Lookup() *GroupsLookupCall

Lookup: Looks up the resource name (https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.

func (*GroupsService) Patch

func (r *GroupsService) Patch(name string, group *Group) *GroupsPatchCall

Patch: Updates a `Group`.

func (*GroupsService) Search

func (r *GroupsService) Search() *GroupsSearchCall

Search: Searches for `Group` resources matching a specified query.

type ListGroupsResponse

type ListGroupsResponse struct {
	// Groups: Groups returned in response to list request. The results are
	// not sorted.
	Groups []*Group `json:"groups,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results available for listing.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Groups") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Groups") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListGroupsResponse: Response message for ListGroups operation.

func (*ListGroupsResponse) MarshalJSON

func (s *ListGroupsResponse) MarshalJSON() ([]byte, error)

type ListMembershipsResponse

type ListMembershipsResponse struct {
	// Memberships: The `Membership`s under the specified `parent`.
	Memberships []*Membership `json:"memberships,omitempty"`

	// NextPageToken: A continuation token to retrieve the next page of
	// results, or empty if there are no more results available.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Memberships") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Memberships") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListMembershipsResponse: The response message for MembershipsService.ListMemberships.

func (*ListMembershipsResponse) MarshalJSON

func (s *ListMembershipsResponse) MarshalJSON() ([]byte, error)

type LookupGroupNameResponse

type LookupGroupNameResponse struct {
	// Name: The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// looked-up `Group`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LookupGroupNameResponse: The response message for GroupsService.LookupGroupName.

func (*LookupGroupNameResponse) MarshalJSON

func (s *LookupGroupNameResponse) MarshalJSON() ([]byte, error)

type LookupMembershipNameResponse

type LookupMembershipNameResponse struct {
	// Name: The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// looked-up `Membership`. Must be of the form
	// `groups/{group_id}/memberships/{membership_id}`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LookupMembershipNameResponse: The response message for MembershipsService.LookupMembershipName.

func (*LookupMembershipNameResponse) MarshalJSON

func (s *LookupMembershipNameResponse) MarshalJSON() ([]byte, error)

type MemberRelation added in v0.37.0

type MemberRelation struct {
	// Member: Resource name for this member.
	Member string `json:"member,omitempty"`

	// PreferredMemberKey: Entity key has an id and a namespace. In case of
	// discussion forums, the id will be an email address without a
	// namespace.
	PreferredMemberKey []*EntityKey `json:"preferredMemberKey,omitempty"`

	// RelationType: The relation between the group and the transitive
	// member.
	//
	// Possible values:
	//   "RELATION_TYPE_UNSPECIFIED" - The relation type is undefined or
	// undetermined.
	//   "DIRECT" - The two entities have only a direct membership with each
	// other.
	//   "INDIRECT" - The two entities have only an indirect membership with
	// each other.
	//   "DIRECT_AND_INDIRECT" - The two entities have both a direct and an
	// indirect membership with each other.
	RelationType string `json:"relationType,omitempty"`

	// Roles: The membership role details (i.e name of role and expiry
	// time).
	Roles []*TransitiveMembershipRole `json:"roles,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Member") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Member") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MemberRelation: Message representing a transitive membership of a group.

func (*MemberRelation) MarshalJSON added in v0.37.0

func (s *MemberRelation) MarshalJSON() ([]byte, error)

type Membership

type Membership struct {
	// CreateTime: Output only. The time when the `Membership` was created.
	CreateTime string `json:"createTime,omitempty"`

	// Name: Output only. The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the
	// `Membership`. Shall be of the form
	// `groups/{group_id}/memberships/{membership_id}`.
	Name string `json:"name,omitempty"`

	// PreferredMemberKey: Required. Immutable. The `EntityKey` of the
	// member.
	PreferredMemberKey *EntityKey `json:"preferredMemberKey,omitempty"`

	// Roles: The `MembershipRole`s that apply to the `Membership`. If
	// unspecified, defaults to a single `MembershipRole` with `name`
	// `MEMBER`. Must not contain duplicate `MembershipRole`s with the same
	// `name`.
	Roles []*MembershipRole `json:"roles,omitempty"`

	// Type: Output only. The type of the membership.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Default. Should not be used.
	//   "USER" - Represents user type.
	//   "SERVICE_ACCOUNT" - Represents service account type.
	//   "GROUP" - Represents group type.
	//   "SHARED_DRIVE" - Represents Shared drive.
	//   "OTHER" - Represents other type.
	Type string `json:"type,omitempty"`

	// UpdateTime: Output only. The time when the `Membership` was last
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Membership: A membership within the Cloud Identity Groups API. A `Membership` defines a relationship between a `Group` and an entity belonging to that `Group`, referred to as a "member".

func (*Membership) MarshalJSON

func (s *Membership) MarshalJSON() ([]byte, error)

type MembershipAdjacencyList added in v0.37.0

type MembershipAdjacencyList struct {
	// Edges: Each edge contains information about the member that belongs
	// to this group. Note: Fields returned here will help identify the
	// specific Membership resource (e.g name, preferred_member_key and
	// role), but may not be a comprehensive list of all fields.
	Edges []*Membership `json:"edges,omitempty"`

	// Group: Resource name of the group that the members belong to.
	Group string `json:"group,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Edges") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Edges") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MembershipAdjacencyList: Membership graph's path information as an adjacency list.

func (*MembershipAdjacencyList) MarshalJSON added in v0.37.0

func (s *MembershipAdjacencyList) MarshalJSON() ([]byte, error)

type MembershipRole

type MembershipRole struct {
	// ExpiryDetail: The expiry details of the `MembershipRole`. Expiry
	// details are only supported for `MEMBER` `MembershipRoles`. May be set
	// if `name` is `MEMBER`. Must not be set if `name` is any other value.
	ExpiryDetail *ExpiryDetail `json:"expiryDetail,omitempty"`

	// Name: The name of the `MembershipRole`. Must be one of `OWNER`,
	// `MANAGER`, `MEMBER`.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExpiryDetail") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExpiryDetail") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MembershipRole: A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`.

func (*MembershipRole) MarshalJSON

func (s *MembershipRole) MarshalJSON() ([]byte, error)

type ModifyMembershipRolesRequest added in v0.33.0

type ModifyMembershipRolesRequest struct {
	// AddRoles: The `MembershipRole`s to be added. Adding or removing roles
	// in the same request as updating roles is not supported. Must not be
	// set if `update_roles_params` is set.
	AddRoles []*MembershipRole `json:"addRoles,omitempty"`

	// RemoveRoles: The `name`s of the `MembershipRole`s to be removed.
	// Adding or removing roles in the same request as updating roles is not
	// supported. It is not possible to remove the `MEMBER`
	// `MembershipRole`. If you wish to delete a `Membership`, call
	// MembershipsService.DeleteMembership instead. Must not contain
	// `MEMBER`. Must not be set if `update_roles_params` is set.
	RemoveRoles []string `json:"removeRoles,omitempty"`

	// UpdateRolesParams: The `MembershipRole`s to be updated. Updating
	// roles in the same request as adding or removing roles is not
	// supported. Must not be set if either `add_roles` or `remove_roles` is
	// set.
	UpdateRolesParams []*UpdateMembershipRolesParams `json:"updateRolesParams,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AddRoles") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AddRoles") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ModifyMembershipRolesRequest: The request message for MembershipsService.ModifyMembershipRoles.

func (*ModifyMembershipRolesRequest) MarshalJSON added in v0.33.0

func (s *ModifyMembershipRolesRequest) MarshalJSON() ([]byte, error)

type ModifyMembershipRolesResponse added in v0.33.0

type ModifyMembershipRolesResponse struct {
	// Membership: The `Membership` resource after modifying its
	// `MembershipRole`s.
	Membership *Membership `json:"membership,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Membership") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Membership") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ModifyMembershipRolesResponse: The response message for MembershipsService.ModifyMembershipRoles.

func (*ModifyMembershipRolesResponse) MarshalJSON added in v0.33.0

func (s *ModifyMembershipRolesResponse) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. If
	// the original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON

func (s *Operation) MarshalJSON() ([]byte, error)

type SearchGroupsResponse

type SearchGroupsResponse struct {
	// Groups: The `Group` resources that match the search query.
	Groups []*Group `json:"groups,omitempty"`

	// NextPageToken: A continuation token to retrieve the next page of
	// results, or empty if there are no more results available.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Groups") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Groups") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchGroupsResponse: The response message for GroupsService.SearchGroups.

func (*SearchGroupsResponse) MarshalJSON

func (s *SearchGroupsResponse) MarshalJSON() ([]byte, error)

type SearchTransitiveGroupsResponse added in v0.37.0

type SearchTransitiveGroupsResponse struct {
	// Memberships: List of transitive groups satisfying the query.
	Memberships []*GroupRelation `json:"memberships,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results available for listing.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Memberships") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Memberships") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchTransitiveGroupsResponse: The response message for MembershipsService.SearchTransitiveGroups.

func (*SearchTransitiveGroupsResponse) MarshalJSON added in v0.37.0

func (s *SearchTransitiveGroupsResponse) MarshalJSON() ([]byte, error)

type SearchTransitiveMembershipsResponse added in v0.37.0

type SearchTransitiveMembershipsResponse struct {
	// Memberships: List of transitive members satisfying the query.
	Memberships []*MemberRelation `json:"memberships,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Memberships") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Memberships") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchTransitiveMembershipsResponse: The response message for MembershipsService.SearchTransitiveMemberships.

func (*SearchTransitiveMembershipsResponse) MarshalJSON added in v0.37.0

func (s *SearchTransitiveMembershipsResponse) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Devices *DevicesService

	Groups *GroupsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type TransitiveMembershipRole added in v0.37.0

type TransitiveMembershipRole struct {
	// Role: TransitiveMembershipRole in string format. Currently supported
	// TransitiveMembershipRoles: "MEMBER", "OWNER", and "MANAGER".
	Role string `json:"role,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Role") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Role") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TransitiveMembershipRole: Message representing the role of a TransitiveMembership.

func (*TransitiveMembershipRole) MarshalJSON added in v0.37.0

func (s *TransitiveMembershipRole) MarshalJSON() ([]byte, error)

type UpdateMembershipRolesParams added in v0.38.0

type UpdateMembershipRolesParams struct {
	// FieldMask: The fully-qualified names of fields to update. May only
	// contain the field `expiry_detail.expire_time`.
	FieldMask string `json:"fieldMask,omitempty"`

	// MembershipRole: The `MembershipRole`s to be updated. Only `MEMBER`
	// `MembershipRole` can currently be updated.
	MembershipRole *MembershipRole `json:"membershipRole,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FieldMask") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FieldMask") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateMembershipRolesParams: The details of an update to a `MembershipRole`.

func (*UpdateMembershipRolesParams) MarshalJSON added in v0.38.0

func (s *UpdateMembershipRolesParams) MarshalJSON() ([]byte, error)

type UserInvitation added in v0.38.0

type UserInvitation struct {
	// MailsSentCount: Number of invitation emails sent to the user.
	MailsSentCount int64 `json:"mailsSentCount,omitempty,string"`

	// Name: Shall be of the form
	// `customers/{customer}/userinvitations/{user_email_address}`.
	Name string `json:"name,omitempty"`

	// State: State of the `UserInvitation`.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The default value. This value is used if the
	// state is omitted.
	//   "NOT_YET_SENT" - The `UserInvitation` has been created and is ready
	// for sending as an email.
	//   "INVITED" - The user has been invited by email.
	//   "ACCEPTED" - The user has accepted the invitation and is part of
	// the organization.
	//   "DECLINED" - The user declined the invitation.
	State string `json:"state,omitempty"`

	// UpdateTime: Time when the `UserInvitation` was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MailsSentCount") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MailsSentCount") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

UserInvitation: The `UserInvitation` resource represents an email that can be sent to an unmanaged user account inviting them to join the customer’s Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the `UserInvitation`, the user account will become managed.

func (*UserInvitation) MarshalJSON added in v0.38.0

func (s *UserInvitation) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL