cloudidentity

package
v0.213.0 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: BSD-3-Clause Imports: 18 Imported by: 10

Documentation

Overview

Package cloudidentity provides access to the Cloud Identity API.

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

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/cloudidentity/v1beta1"
...
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 google.golang.org/api/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 google.golang.org/api/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 google.golang.org/api/option.WithTokenSource: 

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

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// Private Service: https://www.googleapis.com/auth/cloud-identity.devices
	CloudIdentityDevicesScope = "https://www.googleapis.com/auth/cloud-identity.devices"

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

	// Private Service:
	// https://www.googleapis.com/auth/cloud-identity.devices.readonly
	CloudIdentityDevicesReadonlyScope = "https://www.googleapis.com/auth/cloud-identity.devices.readonly"

	// 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 and edit all of the Inbound SSO profiles and their assignments to any
	// Org Units or Google Groups in your Cloud Identity Organization.
	CloudIdentityInboundssoScope = "https://www.googleapis.com/auth/cloud-identity.inboundsso"

	// See all of the Inbound SSO profiles and their assignments to any Org Units
	// or Google Groups in your Cloud Identity Organization.
	CloudIdentityInboundssoReadonlyScope = "https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly"

	// See and edit policies in your Cloud Identity Organization.
	CloudIdentityPoliciesScope = "https://www.googleapis.com/auth/cloud-identity.policies"

	// See policies in your Cloud Identity Organization.
	CloudIdentityPoliciesReadonlyScope = "https://www.googleapis.com/auth/cloud-identity.policies.readonly"

	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	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 AddIdpCredentialOperationMetadata added in v0.100.0 

type AddIdpCredentialOperationMetadata struct {
	// State: State of this Operation Will be "awaiting-multi-party-approval" when
	// the operation is deferred due to the target customer having enabled
	// Multi-party approval for sensitive actions
	// (https://support.google.com/a/answer/13790448).
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AddIdpCredentialOperationMetadata: LRO response metadata for InboundSamlSsoProfilesService.AddIdpCredential.

func (AddIdpCredentialOperationMetadata) MarshalJSON added in v0.185.0 

func (s AddIdpCredentialOperationMetadata) MarshalJSON() ([]byte, error)

type AddIdpCredentialRequest added in v0.100.0 

type AddIdpCredentialRequest struct {
	// PemData: PEM encoded x509 certificate containing the public key for
	// verifying IdP signatures.
	PemData string `json:"pemData,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PemData") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PemData") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AddIdpCredentialRequest: The request for creating an IdpCredential with its associated payload. An InboundSamlSsoProfile can own up to 2 credentials.

func (AddIdpCredentialRequest) MarshalJSON added in v0.100.0 

func (s AddIdpCredentialRequest) MarshalJSON() ([]byte, error)

type AndroidAttributes added in v0.22.0 

type AndroidAttributes struct {
	// CtsProfileMatch: Whether the device passes Android CTS compliance.
	CtsProfileMatch bool `json:"ctsProfileMatch,omitempty"`
	// EnabledUnknownSources: Whether applications from unknown sources can be
	// installed on device.
	EnabledUnknownSources bool `json:"enabledUnknownSources,omitempty"`
	// HasPotentiallyHarmfulApps: Whether any potentially harmful apps were
	// detected on the device.
	HasPotentiallyHarmfulApps bool `json:"hasPotentiallyHarmfulApps,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"`
	// VerifiedBoot: Whether Android verified boot status is GREEN.
	VerifiedBoot bool `json:"verifiedBoot,omitempty"`
	// VerifyAppsEnabled: Whether Google Play Protect Verify Apps is enabled.
	VerifyAppsEnabled bool `json:"verifyAppsEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CtsProfileMatch") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CtsProfileMatch") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (AndroidAttributes) MarshalJSON added in v0.22.0 

func (s AndroidAttributes) MarshalJSON() ([]byte, error)

type ApproveDeviceUserRequest added in v0.31.0 

type ApproveDeviceUserRequest 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ApproveDeviceUserRequest) MarshalJSON added in v0.31.0 

func (s ApproveDeviceUserRequest) MarshalJSON() ([]byte, error)

type ApproveDeviceUserResponse added in v0.22.0 

type ApproveDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *DeviceUser `json:"deviceUser,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ApproveDeviceUserResponse) MarshalJSON added in v0.22.0 

func (s ApproveDeviceUserResponse) MarshalJSON() ([]byte, error)

type BlockDeviceUserRequest added in v0.31.0 

type BlockDeviceUserRequest 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BlockDeviceUserRequest: Request message for blocking account on device.

func (BlockDeviceUserRequest) MarshalJSON added in v0.31.0 

func (s BlockDeviceUserRequest) MarshalJSON() ([]byte, error)

type BlockDeviceUserResponse added in v0.22.0 

type BlockDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *DeviceUser `json:"deviceUser,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (BlockDeviceUserResponse) MarshalJSON added in v0.22.0 

func (s BlockDeviceUserResponse) MarshalJSON() ([]byte, error)

type BrowserAttributes added in v0.162.0 

type BrowserAttributes struct {
	// ChromeBrowserInfo: Represents the current state of the Chrome browser
	// attributes
	// (https://cloud.google.com/access-context-manager/docs/browser-attributes)
	// sent by the Endpoint Verification extension
	// (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).
	ChromeBrowserInfo *BrowserInfo `json:"chromeBrowserInfo,omitempty"`
	// ChromeProfileId: Chrome profile ID that is exposed by the Chrome API. It is
	// unique for each device.
	ChromeProfileId string `json:"chromeProfileId,omitempty"`
	// LastProfileSyncTime: Timestamp in milliseconds since the Unix epoch when the
	// profile/gcm id was last synced.
	LastProfileSyncTime string `json:"lastProfileSyncTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChromeBrowserInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChromeBrowserInfo") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BrowserAttributes: Contains information about browser profiles reported by the Endpoint Verification extension (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).

func (BrowserAttributes) MarshalJSON added in v0.162.0 

func (s BrowserAttributes) MarshalJSON() ([]byte, error)

type BrowserInfo added in v0.162.0 

type BrowserInfo struct {
	// BrowserManagementState: Output only. Browser's management state.
	//
	// Possible values:
	//   "UNSPECIFIED" - Management state is not specified.
	//   "UNMANAGED" - Browser/Profile is not managed by any customer.
	//   "MANAGED_BY_OTHER_DOMAIN" - Browser/Profile is managed, but by some other
	// customer.
	//   "PROFILE_MANAGED" - Profile is managed by customer.
	//   "BROWSER_MANAGED" - Browser is managed by customer.
	BrowserManagementState string `json:"browserManagementState,omitempty"`
	// BrowserVersion: Version of the request initiating browser. E.g.
	// `91.0.4442.4`.
	BrowserVersion string `json:"browserVersion,omitempty"`
	// IsBuiltInDnsClientEnabled: Current state of built-in DNS client
	// (https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled).
	IsBuiltInDnsClientEnabled bool `json:"isBuiltInDnsClientEnabled,omitempty"`
	// IsBulkDataEntryAnalysisEnabled: Current state of bulk data analysis
	// (https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsBulkDataEntryAnalysisEnabled bool `json:"isBulkDataEntryAnalysisEnabled,omitempty"`
	// IsChromeCleanupEnabled: Current state of Chrome Cleanup
	// (https://chromeenterprise.google/policies/#ChromeCleanupEnabled).
	IsChromeCleanupEnabled bool `json:"isChromeCleanupEnabled,omitempty"`
	// IsChromeRemoteDesktopAppBlocked: Current state of Chrome Remote Desktop app
	// (https://chromeenterprise.google/policies/#URLBlocklist).
	IsChromeRemoteDesktopAppBlocked bool `json:"isChromeRemoteDesktopAppBlocked,omitempty"`
	// IsFileDownloadAnalysisEnabled: Current state of file download analysis
	// (https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsFileDownloadAnalysisEnabled bool `json:"isFileDownloadAnalysisEnabled,omitempty"`
	// IsFileUploadAnalysisEnabled: Current state of file upload analysis
	// (https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsFileUploadAnalysisEnabled bool `json:"isFileUploadAnalysisEnabled,omitempty"`
	// IsRealtimeUrlCheckEnabled: Current state of real-time URL check
	// (https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode).
	// Set to true if provider list from Chrome is non-empty.
	IsRealtimeUrlCheckEnabled bool `json:"isRealtimeUrlCheckEnabled,omitempty"`
	// IsSecurityEventAnalysisEnabled: Current state of security event analysis
	// (https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsSecurityEventAnalysisEnabled bool `json:"isSecurityEventAnalysisEnabled,omitempty"`
	// IsSiteIsolationEnabled: Current state of site isolation
	// (https://chromeenterprise.google/policies/?policy=IsolateOrigins).
	IsSiteIsolationEnabled bool `json:"isSiteIsolationEnabled,omitempty"`
	// IsThirdPartyBlockingEnabled: Current state of third-party blocking
	// (https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled).
	IsThirdPartyBlockingEnabled bool `json:"isThirdPartyBlockingEnabled,omitempty"`
	// PasswordProtectionWarningTrigger: Current state of password protection
	// trigger
	// (https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger).
	//
	// Possible values:
	//   "PASSWORD_PROTECTION_TRIGGER_UNSPECIFIED" - Password protection is not
	// specified.
	//   "PROTECTION_OFF" - Password reuse is never detected.
	//   "PASSWORD_REUSE" - Warning is shown when the user reuses their protected
	// password on a non-allowed site.
	//   "PHISHING_REUSE" - Warning is shown when the user reuses their protected
	// password on a phishing site.
	PasswordProtectionWarningTrigger string `json:"passwordProtectionWarningTrigger,omitempty"`
	// SafeBrowsingProtectionLevel: Current state of Safe Browsing protection level
	// (https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel).
	//
	// Possible values:
	//   "SAFE_BROWSING_LEVEL_UNSPECIFIED" - Browser protection level is not
	// specified.
	//   "DISABLED" - No protection against dangerous websites, downloads, and
	// extensions.
	//   "STANDARD" - Standard protection against websites, downloads, and
	// extensions that are known to be dangerous.
	//   "ENHANCED" - Faster, proactive protection against dangerous websites,
	// downloads, and extensions.
	SafeBrowsingProtectionLevel string `json:"safeBrowsingProtectionLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BrowserManagementState") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BrowserManagementState") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BrowserInfo: Browser-specific fields reported by the Endpoint Verification extension (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).

func (BrowserInfo) MarshalJSON added in v0.162.0 

func (s BrowserInfo) MarshalJSON() ([]byte, error)

type CancelUserInvitationRequest added in v0.42.0 

type CancelUserInvitationRequest struct {
}

CancelUserInvitationRequest: Request to cancel sent invitation for target email in UserInvitation.

type CancelWipeDeviceRequest added in v0.31.0 

type CancelWipeDeviceRequest 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CancelWipeDeviceRequest: Request message for cancelling an unfinished device wipe.

func (CancelWipeDeviceRequest) MarshalJSON added in v0.31.0 

func (s CancelWipeDeviceRequest) MarshalJSON() ([]byte, error)

type CancelWipeDeviceResponse added in v0.22.0 

type CancelWipeDeviceResponse struct {
	// Device: Resultant Device object for the action. Note that asset tags will
	// not be returned in the device object.
	Device *Device `json:"device,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Device") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CancelWipeDeviceResponse: Response message for cancelling an unfinished device wipe.

func (CancelWipeDeviceResponse) MarshalJSON added in v0.22.0 

func (s CancelWipeDeviceResponse) MarshalJSON() ([]byte, error)

type CancelWipeDeviceUserRequest added in v0.31.0 

type CancelWipeDeviceUserRequest 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (CancelWipeDeviceUserRequest) MarshalJSON added in v0.31.0 

func (s CancelWipeDeviceUserRequest) MarshalJSON() ([]byte, error)

type CancelWipeDeviceUserResponse added in v0.22.0 

type CancelWipeDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *DeviceUser `json:"deviceUser,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (CancelWipeDeviceUserResponse) MarshalJSON added in v0.22.0 

func (s CancelWipeDeviceUserResponse) MarshalJSON() ([]byte, error)

type CertificateAttributes added in v0.63.0 

type CertificateAttributes struct {
	// CertificateTemplate: The X.509 extension for CertificateTemplate.
	CertificateTemplate *CertificateTemplate `json:"certificateTemplate,omitempty"`
	// Fingerprint: The encoded certificate fingerprint.
	Fingerprint string `json:"fingerprint,omitempty"`
	// Issuer: The name of the issuer of this certificate.
	Issuer string `json:"issuer,omitempty"`
	// SerialNumber: Serial number of the certificate, Example: "123456789".
	SerialNumber string `json:"serialNumber,omitempty"`
	// Subject: The subject name of this certificate.
	Subject string `json:"subject,omitempty"`
	// Thumbprint: The certificate thumbprint.
	Thumbprint string `json:"thumbprint,omitempty"`
	// ValidationState: Validation state of this certificate.
	//
	// Possible values:
	//   "CERTIFICATE_VALIDATION_STATE_UNSPECIFIED" - Default value.
	//   "VALIDATION_SUCCESSFUL" - Certificate validation was successful.
	//   "VALIDATION_FAILED" - Certificate validation failed.
	ValidationState string `json:"validationState,omitempty"`
	// ValidityExpirationTime: Certificate not valid at or after this timestamp.
	ValidityExpirationTime string `json:"validityExpirationTime,omitempty"`
	// ValidityStartTime: Certificate not valid before this timestamp.
	ValidityStartTime string `json:"validityStartTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertificateTemplate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CertificateTemplate") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CertificateAttributes: Stores information about a certificate.

func (CertificateAttributes) MarshalJSON added in v0.63.0 

func (s CertificateAttributes) MarshalJSON() ([]byte, error)

type CertificateTemplate added in v0.61.0 

type CertificateTemplate struct {
	// Id: The template id of the template. Example:
	// "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7
	// 784047".
	Id string `json:"id,omitempty"`
	// MajorVersion: The Major version of the template. Example: 100.
	MajorVersion int64 `json:"majorVersion,omitempty"`
	// MinorVersion: The minor version of the template. Example: 12.
	MinorVersion int64 `json:"minorVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CertificateTemplate: CertificateTemplate (v3 Extension in X.509).

func (CertificateTemplate) MarshalJSON added in v0.61.0 

func (s CertificateTemplate) MarshalJSON() ([]byte, error)

type CheckTransitiveMembershipResponse added in v0.33.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CheckTransitiveMembershipResponse: The response message for MembershipsService.CheckTransitiveMembership.

func (CheckTransitiveMembershipResponse) MarshalJSON added in v0.33.0 

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

type ClientState added in v0.23.0 

type ClientState 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
	//
	// 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]CustomAttributeValue `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.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ClientState) MarshalJSON added in v0.23.0 

func (s ClientState) MarshalJSON() ([]byte, error)

type CreateDeviceRequest added in v0.31.0 

type CreateDeviceRequest 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"`
	// Device: Required. The device to be created. The name field within this
	// device is ignored in the create method. A new name is created by the method,
	// and returned within the response. Only the fields `device_type`,
	// `serial_number` and `asset_tag` (if present) are used to create the device.
	// All other fields are ignored. The `device_type` and `serial_number` fields
	// are required.
	Device *Device `json:"device,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateDeviceRequest: Request message for creating a Company Owned device.

func (CreateDeviceRequest) MarshalJSON added in v0.31.0 

func (s CreateDeviceRequest) MarshalJSON() ([]byte, error)

type CreateInboundSamlSsoProfileOperationMetadata added in v0.100.0 

type CreateInboundSamlSsoProfileOperationMetadata struct {
	// State: State of this Operation Will be "awaiting-multi-party-approval" when
	// the operation is deferred due to the target customer having enabled
	// Multi-party approval for sensitive actions
	// (https://support.google.com/a/answer/13790448).
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateInboundSamlSsoProfileOperationMetadata: LRO response metadata for InboundSamlSsoProfilesService.CreateInboundSamlSsoProfile.

func (CreateInboundSamlSsoProfileOperationMetadata) MarshalJSON added in v0.185.0 

func (s CreateInboundSamlSsoProfileOperationMetadata) MarshalJSON() ([]byte, error)

type CreateInboundSsoAssignmentOperationMetadata added in v0.100.0 

type CreateInboundSsoAssignmentOperationMetadata struct {
}

CreateInboundSsoAssignmentOperationMetadata: LRO response metadata for InboundSsoAssignmentsService.CreateInboundSsoAssignment.

type CustomAttributeValue added in v0.23.0 

type CustomAttributeValue 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (CustomAttributeValue) MarshalJSON added in v0.23.0 

func (s CustomAttributeValue) MarshalJSON() ([]byte, error)

func (*CustomAttributeValue) UnmarshalJSON added in v0.23.0 

func (s *CustomAttributeValue) UnmarshalJSON(data []byte) error

type CustomersService added in v0.42.0 

type CustomersService struct {
	Userinvitations *CustomersUserinvitationsService
	// contains filtered or unexported fields
}

func NewCustomersService added in v0.42.0 

func NewCustomersService(s *Service) *CustomersService

type CustomersUserinvitationsCancelCall added in v0.42.0 

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

func (*CustomersUserinvitationsCancelCall) Context added in v0.42.0 

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

Context sets the context to be used in this call's Do method.

func (*CustomersUserinvitationsCancelCall) Do added in v0.42.0 

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

Do executes the "cloudidentity.customers.userinvitations.cancel" call. 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 (*CustomersUserinvitationsCancelCall) Fields added in v0.42.0 

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

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

func (*CustomersUserinvitationsCancelCall) Header added in v0.42.0 

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

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

type CustomersUserinvitationsGetCall added in v0.42.0 

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

func (*CustomersUserinvitationsGetCall) Context added in v0.42.0 

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

Context sets the context to be used in this call's Do method.

func (*CustomersUserinvitationsGetCall) Do added in v0.42.0 

func (c *CustomersUserinvitationsGetCall) Do(opts ...googleapi.CallOption) (*UserInvitation, error)

Do executes the "cloudidentity.customers.userinvitations.get" call. Any non-2xx status code is an error. Response headers are in either *UserInvitation.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 (*CustomersUserinvitationsGetCall) Fields added in v0.42.0 

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

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

func (*CustomersUserinvitationsGetCall) Header added in v0.42.0 

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

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

func (*CustomersUserinvitationsGetCall) IfNoneMatch added in v0.42.0 

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

IfNoneMatch sets an 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.

type CustomersUserinvitationsIsInvitableUserCall added in v0.42.0 

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

func (*CustomersUserinvitationsIsInvitableUserCall) Context added in v0.42.0 

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

Context sets the context to be used in this call's Do method.

func (*CustomersUserinvitationsIsInvitableUserCall) Do added in v0.42.0 

func (c *CustomersUserinvitationsIsInvitableUserCall) Do(opts ...googleapi.CallOption) (*IsInvitableUserResponse, error)

Do executes the "cloudidentity.customers.userinvitations.isInvitableUser" call. Any non-2xx status code is an error. Response headers are in either *IsInvitableUserResponse.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 (*CustomersUserinvitationsIsInvitableUserCall) Fields added in v0.42.0 

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

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

func (*CustomersUserinvitationsIsInvitableUserCall) Header added in v0.42.0 

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

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

func (*CustomersUserinvitationsIsInvitableUserCall) IfNoneMatch added in v0.42.0 

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

IfNoneMatch sets an 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.

type CustomersUserinvitationsListCall added in v0.42.0 

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

func (*CustomersUserinvitationsListCall) Context added in v0.42.0 

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

Context sets the context to be used in this call's Do method.

func (*CustomersUserinvitationsListCall) Do added in v0.42.0 

func (c *CustomersUserinvitationsListCall) Do(opts ...googleapi.CallOption) (*ListUserInvitationsResponse, error)

Do executes the "cloudidentity.customers.userinvitations.list" call. Any non-2xx status code is an error. Response headers are in either *ListUserInvitationsResponse.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 (*CustomersUserinvitationsListCall) Fields added in v0.42.0 

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

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

func (*CustomersUserinvitationsListCall) Filter added in v0.42.0 

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

Filter sets the optional parameter "filter": A query string for filtering `UserInvitation` results by their current state, in the format: "state=='invited'".

func (*CustomersUserinvitationsListCall) Header added in v0.42.0 

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

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

func (*CustomersUserinvitationsListCall) IfNoneMatch added in v0.42.0 

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

IfNoneMatch sets an 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.

func (*CustomersUserinvitationsListCall) OrderBy added in v0.42.0 

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

OrderBy sets the optional parameter "orderBy": The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using `order_by="email desc". Currently, sorting is supported for `update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not specified, results will be returned based on `email asc` order.

func (*CustomersUserinvitationsListCall) PageSize added in v0.42.0 

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

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

func (*CustomersUserinvitationsListCall) PageToken added in v0.42.0 

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

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListUserInvitations` 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 (*CustomersUserinvitationsListCall) Pages added in v0.42.0 

func (c *CustomersUserinvitationsListCall) Pages(ctx context.Context, f func(*ListUserInvitationsResponse) 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.

type CustomersUserinvitationsSendCall added in v0.42.0 

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

func (*CustomersUserinvitationsSendCall) Context added in v0.42.0 

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

Context sets the context to be used in this call's Do method.

func (*CustomersUserinvitationsSendCall) Do added in v0.42.0 

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

Do executes the "cloudidentity.customers.userinvitations.send" call. 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 (*CustomersUserinvitationsSendCall) Fields added in v0.42.0 

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

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

func (*CustomersUserinvitationsSendCall) Header added in v0.42.0 

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

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

type CustomersUserinvitationsService added in v0.42.0 

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

func NewCustomersUserinvitationsService added in v0.42.0 

func NewCustomersUserinvitationsService(s *Service) *CustomersUserinvitationsService

func (*CustomersUserinvitationsService) Cancel added in v0.42.0 

func (r *CustomersUserinvitationsService) Cancel(name string, canceluserinvitationrequest *CancelUserInvitationRequest) *CustomersUserinvitationsCancelCall

Cancel: Cancels a UserInvitation that was already sent.

  • name: `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`.

func (*CustomersUserinvitationsService) Get added in v0.42.0 

func (r *CustomersUserinvitationsService) Get(name string) *CustomersUserinvitationsGetCall

Get: Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

  • name: `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`.

func (*CustomersUserinvitationsService) IsInvitableUser added in v0.42.0 

func (r *CustomersUserinvitationsService) IsInvitableUser(name string) *CustomersUserinvitationsIsInvitableUserCall

IsInvitableUser: Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers.

  • name: `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`.

func (*CustomersUserinvitationsService) List added in v0.42.0 

func (r *CustomersUserinvitationsService) List(parent string) *CustomersUserinvitationsListCall

List: Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.

  • parent: The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.

func (*CustomersUserinvitationsService) Send added in v0.42.0 

func (r *CustomersUserinvitationsService) Send(name string, senduserinvitationrequest *SendUserInvitationRequest) *CustomersUserinvitationsSendCall

Send: Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. **Note:** The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True.

  • name: `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`.

type DeleteIdpCredentialOperationMetadata added in v0.100.0 

type DeleteIdpCredentialOperationMetadata struct {
}

DeleteIdpCredentialOperationMetadata: LRO response metadata for InboundSamlSsoProfilesService.DeleteIdpCredential.

type DeleteInboundSamlSsoProfileOperationMetadata added in v0.100.0 

type DeleteInboundSamlSsoProfileOperationMetadata struct {
}

DeleteInboundSamlSsoProfileOperationMetadata: LRO response metadata for InboundSamlSsoProfilesService.DeleteInboundSamlSsoProfile.

type DeleteInboundSsoAssignmentOperationMetadata added in v0.100.0 

type DeleteInboundSsoAssignmentOperationMetadata struct {
}

DeleteInboundSsoAssignmentOperationMetadata: LRO response metadata for InboundSsoAssignmentsService.DeleteInboundSsoAssignment.

type Device added in v0.22.0 

type Device struct {
	// AndroidSpecificAttributes: Output only. Attributes specific to Android
	// devices.
	AndroidSpecificAttributes *AndroidAttributes `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"`
	// ClientTypes: List of the clients the device is reporting to.
	//
	// Possible values:
	//   "CLIENT_TYPE_UNSPECIFIED" - Default value
	//   "DRIVE_FS" - Managed by DriveFS
	//   "FUNDAMENTAL" - Management type for every secure device
	//   "ENDPOINT_VERIFICATION" - Managed by Endpoint Verification
	//   "WINDOWS_ADVANCED" - Managed by Windows
	//   "GOOGLE_CREDENTIALS_PROVIDER_FOR_WINDOWS" - Managed by Google credential
	// provider for windows
	ClientTypes []string `json:"clientTypes,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"`
	// DeviceId: Unique identifier for the device.
	DeviceId string `json:"deviceId,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"`
	// EndpointVerificationSpecificAttributes: Output only. Attributes specific to
	// Endpoint Verification
	// (https://cloud.google.com/endpoint-verification/docs/overview) devices.
	EndpointVerificationSpecificAttributes *EndpointVerificationSpecificAttributes `json:"endpointVerificationSpecificAttributes,omitempty"`
	// Hostname: Host name of the device.
	Hostname string `json:"hostname,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"`
	// UnifiedDeviceId: Output only. Unified device id of the device.
	UnifiedDeviceId string `json:"unifiedDeviceId,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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Device: 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. Important: Device API scopes require that you use domain-wide delegation to access the API. For more information, see Set up the Devices API (https://cloud.google.com/identity/docs/how-to/setup-devices).

func (Device) MarshalJSON added in v0.22.0 

func (s Device) MarshalJSON() ([]byte, error)

type DeviceUser added in v0.22.0 

type DeviceUser 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DeviceUser: 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 (DeviceUser) MarshalJSON added in v0.22.0 

func (s DeviceUser) MarshalJSON() ([]byte, error)

type DevicesCancelWipeCall added in v0.31.0 

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

func (*DevicesCancelWipeCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesCancelWipeCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.cancelWipe" call. 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.31.0 

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

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

func (*DevicesCancelWipeCall) Header added in v0.31.0 

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

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

type DevicesCreateCall added in v0.31.0 

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

func (*DevicesCreateCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesCreateCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.create" call. 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.31.0 

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

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

func (*DevicesCreateCall) Header added in v0.31.0 

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

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

type DevicesDeleteCall added in v0.31.0 

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

func (*DevicesDeleteCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeleteCall) Customer added in v0.31.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.31.0 

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

Do executes the "cloudidentity.devices.delete" call. 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.31.0 

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

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

func (*DevicesDeleteCall) Header added in v0.31.0 

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

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

type DevicesDeviceUsersApproveCall added in v0.31.0 

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

func (*DevicesDeviceUsersApproveCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersApproveCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.approve" call. 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.31.0 

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

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

func (*DevicesDeviceUsersApproveCall) Header added in v0.31.0 

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

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

type DevicesDeviceUsersBlockCall added in v0.31.0 

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

func (*DevicesDeviceUsersBlockCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersBlockCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.block" call. 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.31.0 

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

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

func (*DevicesDeviceUsersBlockCall) Header added in v0.31.0 

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

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

type DevicesDeviceUsersCancelWipeCall added in v0.31.0 

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

func (*DevicesDeviceUsersCancelWipeCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersCancelWipeCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.cancelWipe" call. 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.31.0 

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

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

func (*DevicesDeviceUsersCancelWipeCall) Header added in v0.31.0 

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

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

type DevicesDeviceUsersClientStatesGetCall added in v0.31.0 

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

func (*DevicesDeviceUsersClientStatesGetCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersClientStatesGetCall) Customer added in v0.31.0 

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

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.31.0 

func (c *DevicesDeviceUsersClientStatesGetCall) Do(opts ...googleapi.CallOption) (*ClientState, error)

Do executes the "cloudidentity.devices.deviceUsers.clientStates.get" call. Any non-2xx status code is an error. Response headers are in either *ClientState.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.31.0 

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

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

func (*DevicesDeviceUsersClientStatesGetCall) Header added in v0.31.0 

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

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

func (*DevicesDeviceUsersClientStatesGetCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

type DevicesDeviceUsersClientStatesPatchCall added in v0.31.0 

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

func (*DevicesDeviceUsersClientStatesPatchCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersClientStatesPatchCall) Customer added in v0.31.0 

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

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.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.clientStates.patch" call. 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.31.0 

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

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

func (*DevicesDeviceUsersClientStatesPatchCall) Header added in v0.31.0 

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

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

func (*DevicesDeviceUsersClientStatesPatchCall) UpdateMask added in v0.31.0 

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

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.31.0 

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

func NewDevicesDeviceUsersClientStatesService added in v0.31.0 

func NewDevicesDeviceUsersClientStatesService(s *Service) *DevicesDeviceUsersClientStatesService

func (*DevicesDeviceUsersClientStatesService) Get added in v0.31.0 

func (r *DevicesDeviceUsersClientStatesService) Get(name string) *DevicesDeviceUsersClientStatesGetCall

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/{partner_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/{partner_id}` .

func (*DevicesDeviceUsersClientStatesService) Patch added in v0.31.0 

func (r *DevicesDeviceUsersClientStatesService) Patch(name string, clientstate *ClientState) *DevicesDeviceUsersClientStatesPatchCall

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/{partner_id}` , where partner_id corresponds to the partner storing the data.

type DevicesDeviceUsersDeleteCall added in v0.31.0 

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

func (*DevicesDeviceUsersDeleteCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersDeleteCall) Customer added in v0.31.0 

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

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.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.delete" call. 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.31.0 

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

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

func (*DevicesDeviceUsersDeleteCall) Header added in v0.31.0 

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

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

type DevicesDeviceUsersGetCall added in v0.31.0 

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

func (*DevicesDeviceUsersGetCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersGetCall) Customer added in v0.31.0 

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

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.31.0 

func (c *DevicesDeviceUsersGetCall) Do(opts ...googleapi.CallOption) (*DeviceUser, error)

Do executes the "cloudidentity.devices.deviceUsers.get" call. Any non-2xx status code is an error. Response headers are in either *DeviceUser.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.31.0 

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

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

func (*DevicesDeviceUsersGetCall) Header added in v0.31.0 

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

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

func (*DevicesDeviceUsersGetCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

type DevicesDeviceUsersListCall added in v0.31.0 

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

func (*DevicesDeviceUsersListCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersListCall) Customer added in v0.31.0 

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

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.31.0 

func (c *DevicesDeviceUsersListCall) Do(opts ...googleapi.CallOption) (*ListDeviceUsersResponse, error)

Do executes the "cloudidentity.devices.deviceUsers.list" call. Any non-2xx status code is an error. Response headers are in either *ListDeviceUsersResponse.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 (*DevicesDeviceUsersListCall) Fields added in v0.31.0 

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

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

func (*DevicesDeviceUsersListCall) Filter added in v0.31.0 

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

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.31.0 

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

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

func (*DevicesDeviceUsersListCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

func (*DevicesDeviceUsersListCall) OrderBy added in v0.31.0 

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

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

func (*DevicesDeviceUsersListCall) PageSize added in v0.31.0 

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

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.31.0 

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

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.31.0 

func (c *DevicesDeviceUsersListCall) Pages(ctx context.Context, f func(*ListDeviceUsersResponse) 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.

type DevicesDeviceUsersLookupCall added in v0.31.0 

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

func (*DevicesDeviceUsersLookupCall) AndroidId added in v0.31.0 

func (c *DevicesDeviceUsersLookupCall) AndroidId(androidId string) *DevicesDeviceUsersLookupCall

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.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersLookupCall) Do added in v0.31.0 

func (c *DevicesDeviceUsersLookupCall) Do(opts ...googleapi.CallOption) (*LookupSelfDeviceUsersResponse, error)

Do executes the "cloudidentity.devices.deviceUsers.lookup" call. Any non-2xx status code is an error. Response headers are in either *LookupSelfDeviceUsersResponse.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 (*DevicesDeviceUsersLookupCall) Fields added in v0.31.0 

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

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

func (*DevicesDeviceUsersLookupCall) Header added in v0.31.0 

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

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

func (*DevicesDeviceUsersLookupCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

func (*DevicesDeviceUsersLookupCall) PageSize added in v0.31.0 

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

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.31.0 

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

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.31.0 

func (c *DevicesDeviceUsersLookupCall) Pages(ctx context.Context, f func(*LookupSelfDeviceUsersResponse) 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 (*DevicesDeviceUsersLookupCall) RawResourceId added in v0.31.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.31.0 

func (c *DevicesDeviceUsersLookupCall) UserId(userId string) *DevicesDeviceUsersLookupCall

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.31.0 

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

func NewDevicesDeviceUsersService added in v0.31.0 

func NewDevicesDeviceUsersService(s *Service) *DevicesDeviceUsersService

func (*DevicesDeviceUsersService) Approve added in v0.31.0 

func (r *DevicesDeviceUsersService) Approve(name string, approvedeviceuserrequest *ApproveDeviceUserRequest) *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.31.0 

func (r *DevicesDeviceUsersService) Block(name string, blockdeviceuserrequest *BlockDeviceUserRequest) *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.31.0 

func (r *DevicesDeviceUsersService) CancelWipe(name string, cancelwipedeviceuserrequest *CancelWipeDeviceUserRequest) *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.31.0 

func (r *DevicesDeviceUsersService) Delete(name string) *DevicesDeviceUsersDeleteCall

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.31.0 

func (r *DevicesDeviceUsersService) Get(name string) *DevicesDeviceUsersGetCall

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.31.0 

func (r *DevicesDeviceUsersService) List(parent string) *DevicesDeviceUsersListCall

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.31.0 

func (r *DevicesDeviceUsersService) Lookup(parent string) *DevicesDeviceUsersLookupCall

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.31.0 

func (r *DevicesDeviceUsersService) Wipe(name string, wipedeviceuserrequest *WipeDeviceUserRequest) *DevicesDeviceUsersWipeCall

Wipe: Wipes the user's account on a 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 DevicesDeviceUsersWipeCall added in v0.31.0 

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

func (*DevicesDeviceUsersWipeCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesDeviceUsersWipeCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.deviceUsers.wipe" call. 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.31.0 

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

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

func (*DevicesDeviceUsersWipeCall) Header added in v0.31.0 

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

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

type DevicesGetCall added in v0.31.0 

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

func (*DevicesGetCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesGetCall) Customer added in v0.31.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 format: `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.

func (*DevicesGetCall) Do added in v0.31.0 

func (c *DevicesGetCall) Do(opts ...googleapi.CallOption) (*Device, error)

Do executes the "cloudidentity.devices.get" call. Any non-2xx status code is an error. Response headers are in either *Device.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.31.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 details.

func (*DevicesGetCall) Header added in v0.31.0 

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

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

func (*DevicesGetCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

type DevicesListCall added in v0.31.0 

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

func (*DevicesListCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesListCall) Customer added in v0.31.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.

func (*DevicesListCall) Do added in v0.31.0 

func (c *DevicesListCall) Do(opts ...googleapi.CallOption) (*ListDevicesResponse, error)

Do executes the "cloudidentity.devices.list" call. Any non-2xx status code is an error. Response headers are in either *ListDevicesResponse.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 (*DevicesListCall) Fields added in v0.31.0 

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

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

func (*DevicesListCall) Filter added in v0.31.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.31.0 

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

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

func (*DevicesListCall) IfNoneMatch added in v0.31.0 

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

IfNoneMatch sets an 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.

func (*DevicesListCall) OrderBy added in v0.31.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 to specify results to be sorted in descending order. Default order is ascending.

func (*DevicesListCall) PageSize added in v0.31.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.31.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.31.0 

func (c *DevicesListCall) Pages(ctx context.Context, f func(*ListDevicesResponse) 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 (*DevicesListCall) View added in v0.31.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). 

"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.31.0 

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

func NewDevicesService added in v0.31.0 

func NewDevicesService(s *Service) *DevicesService

func (*DevicesService) CancelWipe added in v0.31.0 

func (r *DevicesService) CancelWipe(name string, cancelwipedevicerequest *CancelWipeDeviceRequest) *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.

func (*DevicesService) Create added in v0.31.0 

func (r *DevicesService) Create(createdevicerequest *CreateDeviceRequest) *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.31.0 

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

Delete: Deletes the specified device.

func (*DevicesService) Get added in v0.31.0 

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

Get: Retrieves the specified device.

func (*DevicesService) List added in v0.31.0 

func (r *DevicesService) List() *DevicesListCall

List: Lists/Searches devices.

func (*DevicesService) Wipe added in v0.31.0 

func (r *DevicesService) Wipe(name string, wipedevicerequest *WipeDeviceRequest) *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.31.0 

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

func (*DevicesWipeCall) Context added in v0.31.0 

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

Context sets the context to be used in this call's Do method.

func (*DevicesWipeCall) Do added in v0.31.0 

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

Do executes the "cloudidentity.devices.wipe" call. 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.31.0 

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

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

func (*DevicesWipeCall) Header added in v0.31.0 

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

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

type DsaPublicKeyInfo added in v0.100.0 

type DsaPublicKeyInfo struct {
	// KeySize: Key size in bits (size of parameter P).
	KeySize int64 `json:"keySize,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KeySize") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KeySize") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DsaPublicKeyInfo: Information of a DSA public key.

func (DsaPublicKeyInfo) MarshalJSON added in v0.100.0 

func (s DsaPublicKeyInfo) MarshalJSON() ([]byte, error)

type DynamicGroupMetadata added in v0.31.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 500 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DynamicGroupMetadata: Dynamic group metadata like queries and status.

func (DynamicGroupMetadata) MarshalJSON added in v0.31.0 

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

type DynamicGroupQuery added in v0.31.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')` All users with any variation of the name John Doe
	// (case-insensitive queries add `equalsIgnoreCase()` to the value being
	// queried). `user.name.value.equalsIgnoreCase('jOhn DoE')`
	Query string `json:"query,omitempty"`
	// 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DynamicGroupQuery: Defines a query on a resource.

func (DynamicGroupQuery) MarshalJSON added in v0.31.0 

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

type DynamicGroupStatus added in v0.31.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.
	//   "INVALID_QUERY" - Group is in an unrecoverable state and its memberships
	// can't be 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (DynamicGroupStatus) MarshalJSON added in v0.31.0 

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

type EndpointVerificationSpecificAttributes added in v0.61.0 

type EndpointVerificationSpecificAttributes struct {
	// AdditionalSignals: Additional signals
	// (https://cloud.google.com/endpoint-verification/docs/device-information)
	// reported by Endpoint Verification. It includes the following attributes: *
	// Non-configurable attributes: hotfixes, av_installed, av_enabled,
	// windows_domain_name, is_os_native_firewall_enabled, and
	// is_secure_boot_enabled. * Configurable attributes
	// (https://cloud.google.com/endpoint-verification/docs/collect-config-attributes):
	// file, folder, and binary attributes; registry entries; and properties in a
	// plist.
	AdditionalSignals googleapi.RawMessage `json:"additionalSignals,omitempty"`
	// BrowserAttributes: Details of browser profiles reported by Endpoint
	// Verification.
	BrowserAttributes []*BrowserAttributes `json:"browserAttributes,omitempty"`
	// CertificateAttributes: Details of certificates.
	CertificateAttributes []*CertificateAttributes `json:"certificateAttributes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalSignals") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalSignals") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EndpointVerificationSpecificAttributes: Resource representing the Endpoint Verification-specific attributes (https://cloud.google.com/endpoint-verification/docs/device-information) of a device.

func (EndpointVerificationSpecificAttributes) MarshalJSON added in v0.61.0 

func (s EndpointVerificationSpecificAttributes) MarshalJSON() ([]byte, error)

type EntityKey 

type EntityKey struct {
	// Id: The ID of the entity. For Google-managed entities, the `id` must 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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.30.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ExpiryDetail: The `MembershipRole` expiry details.

func (ExpiryDetail) MarshalJSON added in v0.30.0 

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

type GetMembershipGraphResponse added in v0.21.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GetMembershipGraphResponse: The response message for MembershipsService.GetMembershipGraph.

func (GetMembershipGraphResponse) MarshalJSON added in v0.21.0 

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

type GoogleAppsCloudidentityDevicesV1AndroidAttributes added in v0.31.0 

type GoogleAppsCloudidentityDevicesV1AndroidAttributes struct {
	// CtsProfileMatch: Whether the device passes Android CTS compliance.
	CtsProfileMatch bool `json:"ctsProfileMatch,omitempty"`
	// EnabledUnknownSources: Whether applications from unknown sources can be
	// installed on device.
	EnabledUnknownSources bool `json:"enabledUnknownSources,omitempty"`
	// HasPotentiallyHarmfulApps: Whether any potentially harmful apps were
	// detected on the device.
	HasPotentiallyHarmfulApps bool `json:"hasPotentiallyHarmfulApps,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"`
	// VerifiedBoot: Whether Android verified boot status is GREEN.
	VerifiedBoot bool `json:"verifiedBoot,omitempty"`
	// VerifyAppsEnabled: Whether Google Play Protect Verify Apps is enabled.
	VerifyAppsEnabled bool `json:"verifyAppsEnabled,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CtsProfileMatch") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CtsProfileMatch") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1AndroidAttributes) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1AndroidAttributes) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1ApproveDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1ApproveDeviceUserMetadata: Metadata for ApproveDeviceUser LRO.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1BlockDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1BlockDeviceUserMetadata: Metadata for BlockDeviceUser LRO.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1BrowserAttributes added in v0.170.0 

type GoogleAppsCloudidentityDevicesV1BrowserAttributes struct {
	// ChromeBrowserInfo: Represents the current state of the Chrome browser
	// attributes
	// (https://cloud.google.com/access-context-manager/docs/browser-attributes)
	// sent by the Endpoint Verification extension
	// (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).
	ChromeBrowserInfo *GoogleAppsCloudidentityDevicesV1BrowserInfo `json:"chromeBrowserInfo,omitempty"`
	// ChromeProfileId: Chrome profile ID that is exposed by the Chrome API. It is
	// unique for each device.
	ChromeProfileId string `json:"chromeProfileId,omitempty"`
	// LastProfileSyncTime: Timestamp in milliseconds since the Unix epoch when the
	// profile/gcm id was last synced.
	LastProfileSyncTime string `json:"lastProfileSyncTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChromeBrowserInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChromeBrowserInfo") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1BrowserAttributes: Contains information about browser profiles reported by the Endpoint Verification extension (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).

func (GoogleAppsCloudidentityDevicesV1BrowserAttributes) MarshalJSON added in v0.170.0 

func (s GoogleAppsCloudidentityDevicesV1BrowserAttributes) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1BrowserInfo added in v0.170.0 

type GoogleAppsCloudidentityDevicesV1BrowserInfo struct {
	// BrowserManagementState: Output only. Browser's management state.
	//
	// Possible values:
	//   "UNSPECIFIED" - Management state is not specified.
	//   "UNMANAGED" - Browser/Profile is not managed by any customer.
	//   "MANAGED_BY_OTHER_DOMAIN" - Browser/Profile is managed, but by some other
	// customer.
	//   "PROFILE_MANAGED" - Profile is managed by customer.
	//   "BROWSER_MANAGED" - Browser is managed by customer.
	BrowserManagementState string `json:"browserManagementState,omitempty"`
	// BrowserVersion: Version of the request initiating browser. E.g.
	// `91.0.4442.4`.
	BrowserVersion string `json:"browserVersion,omitempty"`
	// IsBuiltInDnsClientEnabled: Current state of built-in DNS client
	// (https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled).
	IsBuiltInDnsClientEnabled bool `json:"isBuiltInDnsClientEnabled,omitempty"`
	// IsBulkDataEntryAnalysisEnabled: Current state of bulk data analysis
	// (https://chromeenterprise.google/policies/#OnBulkDataEntryEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsBulkDataEntryAnalysisEnabled bool `json:"isBulkDataEntryAnalysisEnabled,omitempty"`
	// IsChromeCleanupEnabled: Current state of Chrome Cleanup
	// (https://chromeenterprise.google/policies/#ChromeCleanupEnabled).
	IsChromeCleanupEnabled bool `json:"isChromeCleanupEnabled,omitempty"`
	// IsChromeRemoteDesktopAppBlocked: Current state of Chrome Remote Desktop app
	// (https://chromeenterprise.google/policies/#URLBlocklist).
	IsChromeRemoteDesktopAppBlocked bool `json:"isChromeRemoteDesktopAppBlocked,omitempty"`
	// IsFileDownloadAnalysisEnabled: Current state of file download analysis
	// (https://chromeenterprise.google/policies/#OnFileDownloadedEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsFileDownloadAnalysisEnabled bool `json:"isFileDownloadAnalysisEnabled,omitempty"`
	// IsFileUploadAnalysisEnabled: Current state of file upload analysis
	// (https://chromeenterprise.google/policies/#OnFileAttachedEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsFileUploadAnalysisEnabled bool `json:"isFileUploadAnalysisEnabled,omitempty"`
	// IsRealtimeUrlCheckEnabled: Current state of real-time URL check
	// (https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode).
	// Set to true if provider list from Chrome is non-empty.
	IsRealtimeUrlCheckEnabled bool `json:"isRealtimeUrlCheckEnabled,omitempty"`
	// IsSecurityEventAnalysisEnabled: Current state of security event analysis
	// (https://chromeenterprise.google/policies/#OnSecurityEventEnterpriseConnector).
	// Set to true if provider list from Chrome is non-empty.
	IsSecurityEventAnalysisEnabled bool `json:"isSecurityEventAnalysisEnabled,omitempty"`
	// IsSiteIsolationEnabled: Current state of site isolation
	// (https://chromeenterprise.google/policies/?policy=IsolateOrigins).
	IsSiteIsolationEnabled bool `json:"isSiteIsolationEnabled,omitempty"`
	// IsThirdPartyBlockingEnabled: Current state of third-party blocking
	// (https://chromeenterprise.google/policies/#ThirdPartyBlockingEnabled).
	IsThirdPartyBlockingEnabled bool `json:"isThirdPartyBlockingEnabled,omitempty"`
	// PasswordProtectionWarningTrigger: Current state of password protection
	// trigger
	// (https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger).
	//
	// Possible values:
	//   "PASSWORD_PROTECTION_TRIGGER_UNSPECIFIED" - Password protection is not
	// specified.
	//   "PROTECTION_OFF" - Password reuse is never detected.
	//   "PASSWORD_REUSE" - Warning is shown when the user reuses their protected
	// password on a non-allowed site.
	//   "PHISHING_REUSE" - Warning is shown when the user reuses their protected
	// password on a phishing site.
	PasswordProtectionWarningTrigger string `json:"passwordProtectionWarningTrigger,omitempty"`
	// SafeBrowsingProtectionLevel: Current state of Safe Browsing protection level
	// (https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel).
	//
	// Possible values:
	//   "SAFE_BROWSING_LEVEL_UNSPECIFIED" - Browser protection level is not
	// specified.
	//   "DISABLED" - No protection against dangerous websites, downloads, and
	// extensions.
	//   "STANDARD" - Standard protection against websites, downloads, and
	// extensions that are known to be dangerous.
	//   "ENHANCED" - Faster, proactive protection against dangerous websites,
	// downloads, and extensions.
	SafeBrowsingProtectionLevel string `json:"safeBrowsingProtectionLevel,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BrowserManagementState") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BrowserManagementState") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1BrowserInfo: Browser-specific fields reported by the Endpoint Verification extension (https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).

func (GoogleAppsCloudidentityDevicesV1BrowserInfo) MarshalJSON added in v0.170.0 

func (s GoogleAppsCloudidentityDevicesV1BrowserInfo) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata struct {
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata: Metadata for CancelWipeDevice LRO.

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse: Response message for cancelling an unfinished device wipe.

func (GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserMetadata: Metadata for CancelWipeDeviceUser LRO.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1CertificateAttributes added in v0.170.0 

type GoogleAppsCloudidentityDevicesV1CertificateAttributes struct {
	// CertificateTemplate: The X.509 extension for CertificateTemplate.
	CertificateTemplate *GoogleAppsCloudidentityDevicesV1CertificateTemplate `json:"certificateTemplate,omitempty"`
	// Fingerprint: The encoded certificate fingerprint.
	Fingerprint string `json:"fingerprint,omitempty"`
	// Issuer: The name of the issuer of this certificate.
	Issuer string `json:"issuer,omitempty"`
	// SerialNumber: Serial number of the certificate, Example: "123456789".
	SerialNumber string `json:"serialNumber,omitempty"`
	// Subject: The subject name of this certificate.
	Subject string `json:"subject,omitempty"`
	// Thumbprint: The certificate thumbprint.
	Thumbprint string `json:"thumbprint,omitempty"`
	// ValidationState: Output only. Validation state of this certificate.
	//
	// Possible values:
	//   "CERTIFICATE_VALIDATION_STATE_UNSPECIFIED" - Default value.
	//   "VALIDATION_SUCCESSFUL" - Certificate validation was successful.
	//   "VALIDATION_FAILED" - Certificate validation failed.
	ValidationState string `json:"validationState,omitempty"`
	// ValidityExpirationTime: Certificate not valid at or after this timestamp.
	ValidityExpirationTime string `json:"validityExpirationTime,omitempty"`
	// ValidityStartTime: Certificate not valid before this timestamp.
	ValidityStartTime string `json:"validityStartTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertificateTemplate") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CertificateTemplate") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CertificateAttributes: Stores information about a certificate.

func (GoogleAppsCloudidentityDevicesV1CertificateAttributes) MarshalJSON added in v0.170.0 

func (s GoogleAppsCloudidentityDevicesV1CertificateAttributes) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1CertificateTemplate added in v0.170.0 

type GoogleAppsCloudidentityDevicesV1CertificateTemplate struct {
	// Id: The template id of the template. Example:
	// "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7
	// 784047".
	Id string `json:"id,omitempty"`
	// MajorVersion: The Major version of the template. Example: 100.
	MajorVersion int64 `json:"majorVersion,omitempty"`
	// MinorVersion: The minor version of the template. Example: 12.
	MinorVersion int64 `json:"minorVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Id") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1CertificateTemplate: CertificateTemplate (v3 Extension in X.509).

func (GoogleAppsCloudidentityDevicesV1CertificateTemplate) MarshalJSON added in v0.170.0 

func (s GoogleAppsCloudidentityDevicesV1CertificateTemplate) MarshalJSON() ([]byte, error)

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}/deviceUsers/{device_user}/clientState/{partner}`,
	// where partner 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}-suffix`, where `customer` 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"`
	// ForceSendFields is a list of field names (e.g. "AssetTags") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 

func (s GoogleAppsCloudidentityDevicesV1ClientState) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1CreateDeviceMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1CreateDeviceMetadata struct {
}

GoogleAppsCloudidentityDevicesV1CreateDeviceMetadata: Metadata for CreateDevice LRO.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1CustomAttributeValue) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1CustomAttributeValue) MarshalJSON() ([]byte, error)

func (*GoogleAppsCloudidentityDevicesV1CustomAttributeValue) UnmarshalJSON added in v0.31.0 

func (s *GoogleAppsCloudidentityDevicesV1CustomAttributeValue) UnmarshalJSON(data []byte) error

type GoogleAppsCloudidentityDevicesV1DeleteDeviceMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1DeleteDeviceMetadata struct {
}

GoogleAppsCloudidentityDevicesV1DeleteDeviceMetadata: Metadata for DeleteDevice LRO.

type GoogleAppsCloudidentityDevicesV1DeleteDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1DeleteDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1DeleteDeviceUserMetadata: Metadata for DeleteDeviceUser LRO.

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"`
	// DeviceId: Unique identifier for the device.
	DeviceId string `json:"deviceId,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"`
	// EndpointVerificationSpecificAttributes: Output only. Attributes specific to
	// Endpoint Verification
	// (https://cloud.google.com/endpoint-verification/docs/overview) devices.
	EndpointVerificationSpecificAttributes *GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes `json:"endpointVerificationSpecificAttributes,omitempty"`
	// Hostname: Host name of the device.
	Hostname string `json:"hostname,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}`, where device is the unique id assigned to the
	// Device. Important: Device API scopes require that you use domain-wide
	// delegation to access the API. For more information, see Set up the Devices
	// API (https://cloud.google.com/identity/docs/how-to/setup-devices).
	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"`
	// UnifiedDeviceId: Output only. Unified device id of the device.
	UnifiedDeviceId string `json:"unifiedDeviceId,omitempty"`
	// WifiMacAddresses: WiFi MAC addresses of device.
	WifiMacAddresses []string `json:"wifiMacAddresses,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AndroidSpecificAttributes")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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}/deviceUsers/{device_user}`, where `device_user`
	// 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"`
	// ForceSendFields is a list of field names (e.g. "CompromisedState") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 

func (s GoogleAppsCloudidentityDevicesV1DeviceUser) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes added in v0.170.0 

type GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes struct {
	// AdditionalSignals: Additional signals
	// (https://cloud.google.com/endpoint-verification/docs/device-information)
	// reported by Endpoint Verification. It includes the following attributes: *
	// Non-configurable attributes: hotfixes, av_installed, av_enabled,
	// windows_domain_name, is_os_native_firewall_enabled, and
	// is_secure_boot_enabled. * Configurable attributes
	// (https://cloud.google.com/endpoint-verification/docs/collect-config-attributes):
	// file, folder, and binary attributes; registry entries; and properties in a
	// plist.
	AdditionalSignals googleapi.RawMessage `json:"additionalSignals,omitempty"`
	// BrowserAttributes: Details of browser profiles reported by Endpoint
	// Verification.
	BrowserAttributes []*GoogleAppsCloudidentityDevicesV1BrowserAttributes `json:"browserAttributes,omitempty"`
	// CertificateAttributes: Details of certificates.
	CertificateAttributes []*GoogleAppsCloudidentityDevicesV1CertificateAttributes `json:"certificateAttributes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalSignals") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalSignals") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes: Resource representing the Endpoint Verification-specific attributes (https://cloud.google.com/endpoint-verification/docs/device-information) of a device.

func (GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes) MarshalJSON added in v0.170.0 

func (s GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata struct {
}

GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata: Metadata for ListEndpointApps LRO.

type GoogleAppsCloudidentityDevicesV1SignoutDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1SignoutDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1SignoutDeviceUserMetadata: Metadata for SignoutDeviceUser LRO.

type GoogleAppsCloudidentityDevicesV1UpdateClientStateMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1UpdateClientStateMetadata struct {
}

GoogleAppsCloudidentityDevicesV1UpdateClientStateMetadata: Metadata for UpdateClientState LRO.

type GoogleAppsCloudidentityDevicesV1UpdateDeviceMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1UpdateDeviceMetadata struct {
}

GoogleAppsCloudidentityDevicesV1UpdateDeviceMetadata: Metadata for UpdateDevice LRO.

type GoogleAppsCloudidentityDevicesV1WipeDeviceMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1WipeDeviceMetadata struct {
}

GoogleAppsCloudidentityDevicesV1WipeDeviceMetadata: Metadata for WipeDevice LRO.

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1WipeDeviceResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1WipeDeviceResponse) MarshalJSON() ([]byte, error)

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserMetadata added in v0.55.0 

type GoogleAppsCloudidentityDevicesV1WipeDeviceUserMetadata struct {
}

GoogleAppsCloudidentityDevicesV1WipeDeviceUserMetadata: Metadata for WipeDeviceUser LRO.

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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse) MarshalJSON added in v0.31.0 

func (s GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse) MarshalJSON() ([]byte, error)

type Group 

type Group struct {
	// AdditionalGroupKeys: Output only. Additional group keys associated with the
	// Group.
	AdditionalGroupKeys []*EntityKey `json:"additionalGroupKeys,omitempty"`
	// 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. 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}` for external identity-mapped
	// groups (https://support.google.com/a/answer/9039510) or
	// `customers/{customer_id}` for Google Groups. The `customer_id` must begin
	// with "C" (for example, 'C046psxkn'). [Find your customer ID.]
	// (https://support.google.com/cloudidentity/answer/10070793)
	Parent string `json:"parent,omitempty"`
	// PosixGroups: Optional. The POSIX groups associated with the `Group`.
	PosixGroups []*PosixGroup `json:"posixGroups,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. "AdditionalGroupKeys") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalGroupKeys") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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.33.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GroupRelation) MarshalJSON added in v0.33.0 

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

type GroupsCreateCall 

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

func (*GroupsCreateCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*GroupsCreateCall) Do 

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

Do executes the "cloudidentity.groups.create" call. 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 

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

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

func (*GroupsCreateCall) Header 

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

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

func (*GroupsCreateCall) InitialGroupConfig added in v0.17.0 

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

InitialGroupConfig sets the optional parameter "initialGroupConfig": Required. 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 

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

Context sets the context to be used in this call's Do method.

func (*GroupsDeleteCall) Do 

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

Do executes the "cloudidentity.groups.delete" call. 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 

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

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

func (*GroupsDeleteCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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.

func (*GroupsGetCall) Do 

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

Do executes the "cloudidentity.groups.get" call. 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 details.

func (*GroupsGetCall) Header 

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

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

func (*GroupsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type GroupsGetSecuritySettingsCall added in v0.59.0 

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

func (*GroupsGetSecuritySettingsCall) Context added in v0.59.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsGetSecuritySettingsCall) Do added in v0.59.0 

func (c *GroupsGetSecuritySettingsCall) Do(opts ...googleapi.CallOption) (*SecuritySettings, error)

Do executes the "cloudidentity.groups.getSecuritySettings" call. Any non-2xx status code is an error. Response headers are in either *SecuritySettings.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 (*GroupsGetSecuritySettingsCall) Fields added in v0.59.0 

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

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

func (*GroupsGetSecuritySettingsCall) Header added in v0.59.0 

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

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

func (*GroupsGetSecuritySettingsCall) IfNoneMatch added in v0.59.0 

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

IfNoneMatch sets an 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.

func (*GroupsGetSecuritySettingsCall) ReadMask added in v0.59.0 

func (c *GroupsGetSecuritySettingsCall) ReadMask(readMask string) *GroupsGetSecuritySettingsCall

ReadMask sets the optional parameter "readMask": Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field: `member_restriction`.

type GroupsListCall added in v0.17.0 

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

func (*GroupsListCall) Context added in v0.17.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsListCall) Do added in v0.17.0 

func (c *GroupsListCall) Do(opts ...googleapi.CallOption) (*ListGroupsResponse, error)

Do executes the "cloudidentity.groups.list" call. 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 added in v0.17.0 

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 details.

func (*GroupsListCall) Header added in v0.17.0 

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

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

func (*GroupsListCall) IfNoneMatch added in v0.17.0 

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

IfNoneMatch sets an 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.

func (*GroupsListCall) PageSize added in v0.17.0 

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 added in v0.17.0 

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 added in v0.17.0 

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 added in v0.17.0 

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'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)

func (*GroupsListCall) View added in v0.17.0 

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 

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

Context sets the context to be used in this call's Do method.

func (*GroupsLookupCall) Do 

func (c *GroupsLookupCall) Do(opts ...googleapi.CallOption) (*LookupGroupNameResponse, error)

Do executes the "cloudidentity.groups.lookup" call. 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 

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

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

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` must 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 a http.Header that can be modified by the caller to add headers to the request.

func (*GroupsLookupCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type GroupsMembershipsCheckTransitiveMembershipCall added in v0.33.0 

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

func (*GroupsMembershipsCheckTransitiveMembershipCall) Context added in v0.33.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Do added in v0.33.0 

func (c *GroupsMembershipsCheckTransitiveMembershipCall) Do(opts ...googleapi.CallOption) (*CheckTransitiveMembershipResponse, error)

Do executes the "cloudidentity.groups.memberships.checkTransitiveMembership" call. 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.33.0 

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

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

func (*GroupsMembershipsCheckTransitiveMembershipCall) Header added in v0.33.0 

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

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

func (*GroupsMembershipsCheckTransitiveMembershipCall) IfNoneMatch added in v0.33.0 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsCheckTransitiveMembershipCall) Query added in v0.33.0 

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

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 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsCreateCall) Do 

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

Do executes the "cloudidentity.groups.memberships.create" call. 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 

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

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

func (*GroupsMembershipsCreateCall) Header 

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

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

type GroupsMembershipsDeleteCall 

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

func (*GroupsMembershipsDeleteCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsDeleteCall) Do 

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

Do executes the "cloudidentity.groups.memberships.delete" call. 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 

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

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

func (*GroupsMembershipsDeleteCall) Header 

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

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

type GroupsMembershipsGetCall 

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

func (*GroupsMembershipsGetCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsGetCall) Do 

func (c *GroupsMembershipsGetCall) Do(opts ...googleapi.CallOption) (*Membership, error)

Do executes the "cloudidentity.groups.memberships.get" call. 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 

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

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

func (*GroupsMembershipsGetCall) Header 

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

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

func (*GroupsMembershipsGetCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

type GroupsMembershipsGetMembershipGraphCall added in v0.33.0 

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

func (*GroupsMembershipsGetMembershipGraphCall) Context added in v0.33.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsGetMembershipGraphCall) Do added in v0.33.0 

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

Do executes the "cloudidentity.groups.memberships.getMembershipGraph" call. 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.33.0 

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

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

func (*GroupsMembershipsGetMembershipGraphCall) Header added in v0.33.0 

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

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

func (*GroupsMembershipsGetMembershipGraphCall) IfNoneMatch added in v0.33.0 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsGetMembershipGraphCall) Query added in v0.33.0 

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

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 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsListCall) Do 

func (c *GroupsMembershipsListCall) Do(opts ...googleapi.CallOption) (*ListMembershipsResponse, error)

Do executes the "cloudidentity.groups.memberships.list" call. 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 

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

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

func (*GroupsMembershipsListCall) Header 

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

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

func (*GroupsMembershipsListCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsListCall) PageSize 

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

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 

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

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

func (*GroupsMembershipsListCall) Pages 

func (c *GroupsMembershipsListCall) Pages(ctx context.Context, f func(*ListMembershipsResponse) 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 (*GroupsMembershipsListCall) View 

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

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

Possible values: 

"BASIC" - Default. 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 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsLookupCall) Do 

func (c *GroupsMembershipsLookupCall) Do(opts ...googleapi.CallOption) (*LookupMembershipNameResponse, error)

Do executes the "cloudidentity.groups.memberships.lookup" call. 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 

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

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

func (*GroupsMembershipsLookupCall) Header 

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

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

func (*GroupsMembershipsLookupCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

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` must 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.17.0 

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

func (*GroupsMembershipsModifyMembershipRolesCall) Context added in v0.17.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsModifyMembershipRolesCall) Do added in v0.17.0 

func (c *GroupsMembershipsModifyMembershipRolesCall) Do(opts ...googleapi.CallOption) (*ModifyMembershipRolesResponse, error)

Do executes the "cloudidentity.groups.memberships.modifyMembershipRoles" call. 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.17.0 

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

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

func (*GroupsMembershipsModifyMembershipRolesCall) Header added in v0.17.0 

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

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

type GroupsMembershipsSearchDirectGroupsCall added in v0.115.0 

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

func (*GroupsMembershipsSearchDirectGroupsCall) Context added in v0.115.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsSearchDirectGroupsCall) Do added in v0.115.0 

func (c *GroupsMembershipsSearchDirectGroupsCall) Do(opts ...googleapi.CallOption) (*SearchDirectGroupsResponse, error)

Do executes the "cloudidentity.groups.memberships.searchDirectGroups" call. Any non-2xx status code is an error. Response headers are in either *SearchDirectGroupsResponse.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 (*GroupsMembershipsSearchDirectGroupsCall) Fields added in v0.115.0 

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

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

func (*GroupsMembershipsSearchDirectGroupsCall) Header added in v0.115.0 

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

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

func (*GroupsMembershipsSearchDirectGroupsCall) IfNoneMatch added in v0.115.0 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsSearchDirectGroupsCall) OrderBy added in v0.115.0 

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

OrderBy sets the optional parameter "orderBy": The ordering of membership relation for the display name or email in the response. The syntax for this field can be found at https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending display name: order_by="group_name" or order_by="group_name asc". Sort by the descending display name: order_by="group_name desc". Sort by the ascending group key: order_by="group_key" or order_by="group_key asc". Sort by the descending group key: order_by="group_key desc".

func (*GroupsMembershipsSearchDirectGroupsCall) PageSize added in v0.115.0 

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

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

func (*GroupsMembershipsSearchDirectGroupsCall) PageToken added in v0.115.0 

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

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

func (*GroupsMembershipsSearchDirectGroupsCall) Pages added in v0.115.0 

func (c *GroupsMembershipsSearchDirectGroupsCall) Pages(ctx context.Context, f func(*SearchDirectGroupsResponse) 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 (*GroupsMembershipsSearchDirectGroupsCall) Query added in v0.115.0 

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

Query sets the optional parameter "query": Required. A CEL expression that MUST include member specification AND label(s). 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' && 'label_value' in labels`

type GroupsMembershipsSearchTransitiveGroupsCall added in v0.33.0 

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

func (*GroupsMembershipsSearchTransitiveGroupsCall) Context added in v0.33.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsSearchTransitiveGroupsCall) Do added in v0.33.0 

func (c *GroupsMembershipsSearchTransitiveGroupsCall) Do(opts ...googleapi.CallOption) (*SearchTransitiveGroupsResponse, error)

Do executes the "cloudidentity.groups.memberships.searchTransitiveGroups" call. 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.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveGroupsCall) Header added in v0.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveGroupsCall) IfNoneMatch added in v0.33.0 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsSearchTransitiveGroupsCall) PageSize added in v0.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveGroupsCall) PageToken added in v0.33.0 

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

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.33.0 

func (c *GroupsMembershipsSearchTransitiveGroupsCall) Pages(ctx context.Context, f func(*SearchTransitiveGroupsResponse) 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 (*GroupsMembershipsSearchTransitiveGroupsCall) Query added in v0.33.0 

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

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` Query may optionally contain equality operators on the parent of the group restricting the search within a particular customer, e.g. `parent == 'customers/{customer_id}'`. The `customer_id` must begin with "C" (for example, 'C046psxkn'). This filtering is only supported for Admins with groups read permissions on the input customer. Example query: `member_key_id == 'member_key_id_value' && in labels && parent == 'customers/C046psxkn'`

type GroupsMembershipsSearchTransitiveMembershipsCall added in v0.33.0 

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

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Context added in v0.33.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Do added in v0.33.0 

func (c *GroupsMembershipsSearchTransitiveMembershipsCall) Do(opts ...googleapi.CallOption) (*SearchTransitiveMembershipsResponse, error)

Do executes the "cloudidentity.groups.memberships.searchTransitiveMemberships" call. 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.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveMembershipsCall) Header added in v0.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveMembershipsCall) IfNoneMatch added in v0.33.0 

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

IfNoneMatch sets an 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.

func (*GroupsMembershipsSearchTransitiveMembershipsCall) PageSize added in v0.33.0 

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

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

func (*GroupsMembershipsSearchTransitiveMembershipsCall) PageToken added in v0.33.0 

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

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.33.0 

func (c *GroupsMembershipsSearchTransitiveMembershipsCall) Pages(ctx context.Context, f func(*SearchTransitiveMembershipsResponse) 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.

type GroupsMembershipsService 

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

func NewGroupsMembershipsService 

func NewGroupsMembershipsService(s *Service) *GroupsMembershipsService

func (*GroupsMembershipsService) CheckTransitiveMembership added in v0.33.0 

func (r *GroupsMembershipsService) CheckTransitiveMembership(parent string) *GroupsMembershipsCheckTransitiveMembershipCall

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

func (r *GroupsMembershipsService) Create(parent string, membership *Membership) *GroupsMembershipsCreateCall

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 

func (r *GroupsMembershipsService) Delete(name string) *GroupsMembershipsDeleteCall

Delete: Deletes a `Membership`.

func (*GroupsMembershipsService) Get 

func (r *GroupsMembershipsService) Get(name string) *GroupsMembershipsGetCall

Get: Retrieves a `Membership`.

func (*GroupsMembershipsService) GetMembershipGraph added in v0.33.0 

func (r *GroupsMembershipsService) GetMembershipGraph(parent string) *GroupsMembershipsGetMembershipGraphCall

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. 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 `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 

func (r *GroupsMembershipsService) List(parent string) *GroupsMembershipsListCall

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 

func (r *GroupsMembershipsService) Lookup(parent string) *GroupsMembershipsLookupCall

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.17.0 

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

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

func (*GroupsMembershipsService) SearchDirectGroups added in v0.115.0 

func (r *GroupsMembershipsService) SearchDirectGroups(parent string) *GroupsMembershipsSearchDirectGroupsCall

SearchDirectGroups: Searches direct groups of a member.

func (*GroupsMembershipsService) SearchTransitiveGroups added in v0.33.0 

func (r *GroupsMembershipsService) SearchTransitiveGroups(parent string) *GroupsMembershipsSearchTransitiveGroupsCall

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. 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.33.0 

func (r *GroupsMembershipsService) SearchTransitiveMemberships(parent string) *GroupsMembershipsSearchTransitiveMembershipsCall

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

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

Context sets the context to be used in this call's Do method.

func (*GroupsPatchCall) Do 

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

Do executes the "cloudidentity.groups.patch" call. 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 

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

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

func (*GroupsPatchCall) Header 

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

Header returns a http.Header that can be modified by the caller to add 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 field names: `display_name`, `description`, `labels`, `dynamic_group_metadata`, `posix_groups`.

type GroupsSearchCall 

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

func (*GroupsSearchCall) Context 

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

Context sets the context to be used in this call's Do method.

func (*GroupsSearchCall) Do 

func (c *GroupsSearchCall) Do(opts ...googleapi.CallOption) (*SearchGroupsResponse, error)

Do executes the "cloudidentity.groups.search" call. 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 

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

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

func (*GroupsSearchCall) Header 

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

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

func (*GroupsSearchCall) IfNoneMatch 

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

IfNoneMatch sets an 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.

func (*GroupsSearchCall) OrderBy added in v0.106.0 

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

OrderBy sets the optional parameter "orderBy": The ordering of groups for the display name or email in the search groups response. The syntax for this field can be found at https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending name: order_by="display_name" Sort by the descending group key email: order_by="group_key desc"

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 to 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 

func (c *GroupsSearchCall) Pages(ctx context.Context, f func(*SearchGroupsResponse) 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 (*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). * Must contain equality operators on the parent, e.g. `parent == 'customers/{customer_id}'`. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793) * Can contain optional inclusion operators on `labels` such as `'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). * Can contain an optional equality operator on `domain_name`. e.g. `domain_name == 'examplepetstore.com'` * Can contain optional `startsWith/contains/equality` operators on `group_key`, e.g. `group_key.startsWith('dev')`, `group_key.contains('dev'), group_key == 'dev@examplepetstore.com'` * Can contain optional `startsWith/contains/equality` operators on `display_name`, such as `display_name.startsWith('dev')` , `display_name.contains('dev')`, `display_name == 'dev'`

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: 

"BASIC" - Default. 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) GetSecuritySettings added in v0.59.0 

func (r *GroupsService) GetSecuritySettings(name string) *GroupsGetSecuritySettingsCall

GetSecuritySettings: Get Security Settings

  • name: The security settings to retrieve. Format: `groups/{group_id}/securitySettings`.

func (*GroupsService) List added in v0.17.0 

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.

func (*GroupsService) UpdateSecuritySettings added in v0.59.0 

func (r *GroupsService) UpdateSecuritySettings(name string, securitysettings *SecuritySettings) *GroupsUpdateSecuritySettingsCall

UpdateSecuritySettings: Update Security Settings

  • name: Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`.

type GroupsUpdateSecuritySettingsCall added in v0.59.0 

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

func (*GroupsUpdateSecuritySettingsCall) Context added in v0.59.0 

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

Context sets the context to be used in this call's Do method.

func (*GroupsUpdateSecuritySettingsCall) Do added in v0.59.0 

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

Do executes the "cloudidentity.groups.updateSecuritySettings" call. 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 (*GroupsUpdateSecuritySettingsCall) Fields added in v0.59.0 

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

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

func (*GroupsUpdateSecuritySettingsCall) Header added in v0.59.0 

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

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

func (*GroupsUpdateSecuritySettingsCall) UpdateMask added in v0.59.0 

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

UpdateMask sets the optional parameter "updateMask": Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`.

type IdpCredential added in v0.100.0 

type IdpCredential struct {
	// DsaKeyInfo: Output only. Information of a DSA public key.
	DsaKeyInfo *DsaPublicKeyInfo `json:"dsaKeyInfo,omitempty"`
	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the credential.
	Name string `json:"name,omitempty"`
	// RsaKeyInfo: Output only. Information of a RSA public key.
	RsaKeyInfo *RsaPublicKeyInfo `json:"rsaKeyInfo,omitempty"`
	// UpdateTime: Output only. Time when the `IdpCredential` 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. "DsaKeyInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DsaKeyInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IdpCredential: Credential for verifying signatures produced by the Identity Provider.

func (IdpCredential) MarshalJSON added in v0.100.0 

func (s IdpCredential) MarshalJSON() ([]byte, error)

type InboundSamlSsoProfile added in v0.100.0 

type InboundSamlSsoProfile struct {
	// Customer: Immutable. The customer. For example: `customers/C0123abc`.
	Customer string `json:"customer,omitempty"`
	// DisplayName: Human-readable name of the SAML SSO profile.
	DisplayName string `json:"displayName,omitempty"`
	// IdpConfig: SAML identity provider configuration.
	IdpConfig *SamlIdpConfig `json:"idpConfig,omitempty"`
	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the SAML SSO
	// profile.
	Name string `json:"name,omitempty"`
	// SpConfig: SAML service provider configuration for this SAML SSO profile.
	// These are the service provider details provided by Google that should be
	// configured on the corresponding identity provider.
	SpConfig *SamlSpConfig `json:"spConfig,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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InboundSamlSsoProfile: A SAML 2.0 (https://www.oasis-open.org/standards#samlv2.0) federation between a Google enterprise customer and a SAML identity provider.

func (InboundSamlSsoProfile) MarshalJSON added in v0.100.0 

func (s InboundSamlSsoProfile) MarshalJSON() ([]byte, error)

type InboundSamlSsoProfilesCreateCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesCreateCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesCreateCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSamlSsoProfiles.create" call. 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 (*InboundSamlSsoProfilesCreateCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesCreateCall) Header added in v0.100.0 

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

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

type InboundSamlSsoProfilesDeleteCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesDeleteCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesDeleteCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSamlSsoProfiles.delete" call. 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 (*InboundSamlSsoProfilesDeleteCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesDeleteCall) Header added in v0.100.0 

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

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

type InboundSamlSsoProfilesGetCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesGetCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesGetCall) Do added in v0.100.0 

func (c *InboundSamlSsoProfilesGetCall) Do(opts ...googleapi.CallOption) (*InboundSamlSsoProfile, error)

Do executes the "cloudidentity.inboundSamlSsoProfiles.get" call. Any non-2xx status code is an error. Response headers are in either *InboundSamlSsoProfile.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 (*InboundSamlSsoProfilesGetCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesGetCall) Header added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesGetCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

type InboundSamlSsoProfilesIdpCredentialsAddCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesIdpCredentialsAddCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesIdpCredentialsAddCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSamlSsoProfiles.idpCredentials.add" call. 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 (*InboundSamlSsoProfilesIdpCredentialsAddCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsAddCall) Header added in v0.100.0 

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

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

type InboundSamlSsoProfilesIdpCredentialsDeleteCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesIdpCredentialsDeleteCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesIdpCredentialsDeleteCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSamlSsoProfiles.idpCredentials.delete" call. 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 (*InboundSamlSsoProfilesIdpCredentialsDeleteCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsDeleteCall) Header added in v0.100.0 

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

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

type InboundSamlSsoProfilesIdpCredentialsGetCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesIdpCredentialsGetCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesIdpCredentialsGetCall) Do added in v0.100.0 

func (c *InboundSamlSsoProfilesIdpCredentialsGetCall) Do(opts ...googleapi.CallOption) (*IdpCredential, error)

Do executes the "cloudidentity.inboundSamlSsoProfiles.idpCredentials.get" call. Any non-2xx status code is an error. Response headers are in either *IdpCredential.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 (*InboundSamlSsoProfilesIdpCredentialsGetCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsGetCall) Header added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsGetCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

type InboundSamlSsoProfilesIdpCredentialsListCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesIdpCredentialsListCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesIdpCredentialsListCall) Do added in v0.100.0 

func (c *InboundSamlSsoProfilesIdpCredentialsListCall) Do(opts ...googleapi.CallOption) (*ListIdpCredentialsResponse, error)

Do executes the "cloudidentity.inboundSamlSsoProfiles.idpCredentials.list" call. Any non-2xx status code is an error. Response headers are in either *ListIdpCredentialsResponse.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 (*InboundSamlSsoProfilesIdpCredentialsListCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsListCall) Header added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsListCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

func (*InboundSamlSsoProfilesIdpCredentialsListCall) PageSize added in v0.100.0 

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

PageSize sets the optional parameter "pageSize": The maximum number of `IdpCredential`s to return. The service may return fewer than this value.

func (*InboundSamlSsoProfilesIdpCredentialsListCall) PageToken added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesIdpCredentialsListCall) Pages added in v0.100.0 

func (c *InboundSamlSsoProfilesIdpCredentialsListCall) Pages(ctx context.Context, f func(*ListIdpCredentialsResponse) 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.

type InboundSamlSsoProfilesIdpCredentialsService added in v0.100.0 

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

func NewInboundSamlSsoProfilesIdpCredentialsService added in v0.100.0 

func NewInboundSamlSsoProfilesIdpCredentialsService(s *Service) *InboundSamlSsoProfilesIdpCredentialsService

func (*InboundSamlSsoProfilesIdpCredentialsService) Add added in v0.100.0 

func (r *InboundSamlSsoProfilesIdpCredentialsService) Add(parent string, addidpcredentialrequest *AddIdpCredentialRequest) *InboundSamlSsoProfilesIdpCredentialsAddCall

Add: Adds an IdpCredential. Up to 2 credentials are allowed. When the target customer has enabled Multi-party approval for sensitive actions (https://support.google.com/a/answer/13790448), the `Operation` in the response will have "done": false`, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

  • parent: The InboundSamlSsoProfile that owns the IdpCredential. Format: `inboundSamlSsoProfiles/{sso_profile_id}`.

func (*InboundSamlSsoProfilesIdpCredentialsService) Delete added in v0.100.0 

func (r *InboundSamlSsoProfilesIdpCredentialsService) Delete(name string) *InboundSamlSsoProfilesIdpCredentialsDeleteCall

Delete: Deletes an IdpCredential.

func (*InboundSamlSsoProfilesIdpCredentialsService) Get added in v0.100.0 

func (r *InboundSamlSsoProfilesIdpCredentialsService) Get(name string) *InboundSamlSsoProfilesIdpCredentialsGetCall

Get: Gets an IdpCredential.

func (*InboundSamlSsoProfilesIdpCredentialsService) List added in v0.100.0 

func (r *InboundSamlSsoProfilesIdpCredentialsService) List(parent string) *InboundSamlSsoProfilesIdpCredentialsListCall

List: Returns a list of IdpCredentials in an InboundSamlSsoProfile.

  • parent: The parent, which owns this collection of `IdpCredential`s. Format: `inboundSamlSsoProfiles/{sso_profile_id}`.

type InboundSamlSsoProfilesListCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesListCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesListCall) Do added in v0.100.0 

func (c *InboundSamlSsoProfilesListCall) Do(opts ...googleapi.CallOption) (*ListInboundSamlSsoProfilesResponse, error)

Do executes the "cloudidentity.inboundSamlSsoProfiles.list" call. Any non-2xx status code is an error. Response headers are in either *ListInboundSamlSsoProfilesResponse.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 (*InboundSamlSsoProfilesListCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesListCall) Filter added in v0.100.0 

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

Filter sets the optional parameter "filter": A Common Expression Language (https://github.com/google/cel-spec) expression to filter the results. The only supported filter is filtering by customer. For example: `customer=="customers/C0123abc". Omitting the filter or specifying a filter of `customer=="customers/my_customer" will return the profiles for the customer that the caller (authenticated user) belongs to.

func (*InboundSamlSsoProfilesListCall) Header added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesListCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

func (*InboundSamlSsoProfilesListCall) PageSize added in v0.100.0 

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

PageSize sets the optional parameter "pageSize": The maximum number of InboundSamlSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.

func (*InboundSamlSsoProfilesListCall) PageToken added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesListCall) Pages added in v0.100.0 

func (c *InboundSamlSsoProfilesListCall) Pages(ctx context.Context, f func(*ListInboundSamlSsoProfilesResponse) 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.

type InboundSamlSsoProfilesPatchCall added in v0.100.0 

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

func (*InboundSamlSsoProfilesPatchCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSamlSsoProfilesPatchCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSamlSsoProfiles.patch" call. 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 (*InboundSamlSsoProfilesPatchCall) Fields added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesPatchCall) Header added in v0.100.0 

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

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

func (*InboundSamlSsoProfilesPatchCall) UpdateMask added in v0.100.0 

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

UpdateMask sets the optional parameter "updateMask": Required. The list of fields to be updated.

type InboundSamlSsoProfilesService added in v0.100.0 

type InboundSamlSsoProfilesService struct {
	IdpCredentials *InboundSamlSsoProfilesIdpCredentialsService
	// contains filtered or unexported fields
}

func NewInboundSamlSsoProfilesService added in v0.100.0 

func NewInboundSamlSsoProfilesService(s *Service) *InboundSamlSsoProfilesService

func (*InboundSamlSsoProfilesService) Create added in v0.100.0 

func (r *InboundSamlSsoProfilesService) Create(inboundsamlssoprofile *InboundSamlSsoProfile) *InboundSamlSsoProfilesCreateCall

Create: Creates an InboundSamlSsoProfile for a customer. When the target customer has enabled Multi-party approval for sensitive actions (https://support.google.com/a/answer/13790448), the `Operation` in the response will have "done": false`, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

func (*InboundSamlSsoProfilesService) Delete added in v0.100.0 

func (r *InboundSamlSsoProfilesService) Delete(name string) *InboundSamlSsoProfilesDeleteCall

Delete: Deletes an InboundSamlSsoProfile.

func (*InboundSamlSsoProfilesService) Get added in v0.100.0 

func (r *InboundSamlSsoProfilesService) Get(name string) *InboundSamlSsoProfilesGetCall

Get: Gets an InboundSamlSsoProfile.

func (*InboundSamlSsoProfilesService) List added in v0.100.0 

func (r *InboundSamlSsoProfilesService) List() *InboundSamlSsoProfilesListCall

List: Lists InboundSamlSsoProfiles for a customer.

func (*InboundSamlSsoProfilesService) Patch added in v0.100.0 

func (r *InboundSamlSsoProfilesService) Patch(name string, inboundsamlssoprofile *InboundSamlSsoProfile) *InboundSamlSsoProfilesPatchCall

Patch: Updates an InboundSamlSsoProfile. When the target customer has enabled Multi-party approval for sensitive actions (https://support.google.com/a/answer/13790448), the `Operation` in the response will have "done": false`, it will not have a response, and the metadata will have "state": "awaiting-multi-party-approval".

type InboundSsoAssignment added in v0.100.0 

type InboundSsoAssignment struct {
	// Customer: Immutable. The customer. For example: `customers/C0123abc`.
	Customer string `json:"customer,omitempty"`
	// Name: Output only. Resource name
	// (https://cloud.google.com/apis/design/resource_names) of the Inbound SSO
	// Assignment.
	Name string `json:"name,omitempty"`
	// Rank: Must be zero (which is the default value so it can be omitted) for
	// assignments with `target_org_unit` set and must be greater-than-or-equal-to
	// one for assignments with `target_group` set.
	Rank int64 `json:"rank,omitempty"`
	// SamlSsoInfo: SAML SSO details. Must be set if and only if `sso_mode` is set
	// to `SAML_SSO`.
	SamlSsoInfo *SamlSsoInfo `json:"samlSsoInfo,omitempty"`
	// SignInBehavior: Assertions about users assigned to an IdP will always be
	// accepted from that IdP. This controls whether/when Google should redirect a
	// user to the IdP. Unset (defaults) is the recommended configuration.
	SignInBehavior *SignInBehavior `json:"signInBehavior,omitempty"`
	// SsoMode: Inbound SSO behavior.
	//
	// Possible values:
	//   "SSO_MODE_UNSPECIFIED" - Not allowed.
	//   "SSO_OFF" - Disable SSO for the targeted users.
	//   "SAML_SSO" - Use an external SAML Identity Provider for SSO for the
	// targeted users.
	//   "DOMAIN_WIDE_SAML_IF_ENABLED" - Use the domain-wide SAML Identity Provider
	// for the targeted users if one is configured; otherwise, this is equivalent
	// to `SSO_OFF`. Note that this will also be equivalent to `SSO_OFF` if/when
	// support for domain-wide SAML is removed. Google may disallow this mode at
	// that point and existing assignments with this mode may be automatically
	// changed to `SSO_OFF`.
	SsoMode string `json:"ssoMode,omitempty"`
	// TargetGroup: Immutable. Must be of the form `groups/{group}`.
	TargetGroup string `json:"targetGroup,omitempty"`
	// TargetOrgUnit: Immutable. Must be of the form `orgUnits/{org_unit}`.
	TargetOrgUnit string `json:"targetOrgUnit,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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

InboundSsoAssignment: Targets with "set" SSO assignments and their respective assignments.

func (InboundSsoAssignment) MarshalJSON added in v0.100.0 

func (s InboundSsoAssignment) MarshalJSON() ([]byte, error)

type InboundSsoAssignmentsCreateCall added in v0.100.0 

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

func (*InboundSsoAssignmentsCreateCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSsoAssignmentsCreateCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSsoAssignments.create" call. 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 (*InboundSsoAssignmentsCreateCall) Fields added in v0.100.0 

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

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

func (*InboundSsoAssignmentsCreateCall) Header added in v0.100.0 

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

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

type InboundSsoAssignmentsDeleteCall added in v0.100.0 

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

func (*InboundSsoAssignmentsDeleteCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSsoAssignmentsDeleteCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSsoAssignments.delete" call. 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 (*InboundSsoAssignmentsDeleteCall) Fields added in v0.100.0 

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

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

func (*InboundSsoAssignmentsDeleteCall) Header added in v0.100.0 

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

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

type InboundSsoAssignmentsGetCall added in v0.100.0 

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

func (*InboundSsoAssignmentsGetCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSsoAssignmentsGetCall) Do added in v0.100.0 

func (c *InboundSsoAssignmentsGetCall) Do(opts ...googleapi.CallOption) (*InboundSsoAssignment, error)

Do executes the "cloudidentity.inboundSsoAssignments.get" call. Any non-2xx status code is an error. Response headers are in either *InboundSsoAssignment.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 (*InboundSsoAssignmentsGetCall) Fields added in v0.100.0 

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

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

func (*InboundSsoAssignmentsGetCall) Header added in v0.100.0 

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

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

func (*InboundSsoAssignmentsGetCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

type InboundSsoAssignmentsListCall added in v0.100.0 

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

func (*InboundSsoAssignmentsListCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSsoAssignmentsListCall) Do added in v0.100.0 

func (c *InboundSsoAssignmentsListCall) Do(opts ...googleapi.CallOption) (*ListInboundSsoAssignmentsResponse, error)

Do executes the "cloudidentity.inboundSsoAssignments.list" call. Any non-2xx status code is an error. Response headers are in either *ListInboundSsoAssignmentsResponse.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 (*InboundSsoAssignmentsListCall) Fields added in v0.100.0 

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

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

func (*InboundSsoAssignmentsListCall) Filter added in v0.100.0 

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

Filter sets the optional parameter "filter": A CEL expression to filter the results. The only supported filter is filtering by customer. For example: `customer==customers/C0123abc`. Omitting the filter or specifying a filter of `customer==customers/my_customer` will return the assignments for the customer that the caller (authenticated user) belongs to.

func (*InboundSsoAssignmentsListCall) Header added in v0.100.0 

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

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

func (*InboundSsoAssignmentsListCall) IfNoneMatch added in v0.100.0 

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

IfNoneMatch sets an 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.

func (*InboundSsoAssignmentsListCall) PageSize added in v0.100.0 

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

PageSize sets the optional parameter "pageSize": The maximum number of assignments to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100, though requests with page_size greater than that will be silently interpreted as having this maximum value. This may increase in the futue.

func (*InboundSsoAssignmentsListCall) PageToken added in v0.100.0 

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

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

func (*InboundSsoAssignmentsListCall) Pages added in v0.100.0 

func (c *InboundSsoAssignmentsListCall) Pages(ctx context.Context, f func(*ListInboundSsoAssignmentsResponse) 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.

type InboundSsoAssignmentsPatchCall added in v0.100.0 

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

func (*InboundSsoAssignmentsPatchCall) Context added in v0.100.0 

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

Context sets the context to be used in this call's Do method.

func (*InboundSsoAssignmentsPatchCall) Do added in v0.100.0 

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

Do executes the "cloudidentity.inboundSsoAssignments.patch" call. 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 (*InboundSsoAssignmentsPatchCall) Fields added in v0.100.0 

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

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

func (*InboundSsoAssignmentsPatchCall) Header added in v0.100.0 

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

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

func (*InboundSsoAssignmentsPatchCall) UpdateMask added in v0.100.0 

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

UpdateMask sets the optional parameter "updateMask": Required. The list of fields to be updated.

type InboundSsoAssignmentsService added in v0.100.0 

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

func NewInboundSsoAssignmentsService added in v0.100.0 

func NewInboundSsoAssignmentsService(s *Service) *InboundSsoAssignmentsService

func (*InboundSsoAssignmentsService) Create added in v0.100.0 

func (r *InboundSsoAssignmentsService) Create(inboundssoassignment *InboundSsoAssignment) *InboundSsoAssignmentsCreateCall

Create: Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.

func (*InboundSsoAssignmentsService) Delete added in v0.100.0 

func (r *InboundSsoAssignmentsService) Delete(name string) *InboundSsoAssignmentsDeleteCall

Delete: Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.

func (*InboundSsoAssignmentsService) Get added in v0.100.0 

func (r *InboundSsoAssignmentsService) Get(name string) *InboundSsoAssignmentsGetCall

Get: Gets an InboundSsoAssignment.

func (*InboundSsoAssignmentsService) List added in v0.100.0 

func (r *InboundSsoAssignmentsService) List() *InboundSsoAssignmentsListCall

List: Lists the InboundSsoAssignments for a `Customer`.

func (*InboundSsoAssignmentsService) Patch added in v0.100.0 

func (r *InboundSsoAssignmentsService) Patch(name string, inboundssoassignment *InboundSsoAssignment) *InboundSsoAssignmentsPatchCall

Patch: Updates an InboundSsoAssignment. The body of this request is the `inbound_sso_assignment` field and the `update_mask` is relative to that. For example: a PATCH to `/v1beta1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank` with a body of `{ "rank": 1 }` moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.

type IsInvitableUserResponse added in v0.42.0 

type IsInvitableUserResponse struct {
	// IsInvitableUser: Returns true if the email address is invitable.
	IsInvitableUser bool `json:"isInvitableUser,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "IsInvitableUser") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IsInvitableUser") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

IsInvitableUserResponse: Response for IsInvitableUser RPC.

func (IsInvitableUserResponse) MarshalJSON added in v0.42.0 

func (s IsInvitableUserResponse) MarshalJSON() ([]byte, error)

type ListClientStatesResponse added in v0.24.0 

type ListClientStatesResponse struct {
	// ClientStates: Client states meeting the list restrictions.
	ClientStates []*ClientState `json:"clientStates,omitempty"`
	// NextPageToken: Token to retrieve the next page of results. Empty if there
	// are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClientStates") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListClientStatesResponse: Response message that is returned in LRO result of ListClientStates Operation.

func (ListClientStatesResponse) MarshalJSON added in v0.24.0 

func (s ListClientStatesResponse) MarshalJSON() ([]byte, error)

type ListDeviceUsersResponse added in v0.22.0 

type ListDeviceUsersResponse struct {
	// DeviceUsers: Devices meeting the list restrictions.
	DeviceUsers []*DeviceUser `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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ListDeviceUsersResponse) MarshalJSON added in v0.22.0 

func (s ListDeviceUsersResponse) MarshalJSON() ([]byte, error)

type ListDevicesResponse added in v0.22.0 

type ListDevicesResponse struct {
	// Devices: Devices meeting the list restrictions.
	Devices []*Device `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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ListDevicesResponse) MarshalJSON added in v0.22.0 

func (s ListDevicesResponse) MarshalJSON() ([]byte, error)

type ListGroupsResponse added in v0.17.0 

type ListGroupsResponse struct {
	// Groups: The `Group` resources under the specified `parent`.
	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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListGroupsResponse: The response message for GroupsService.ListGroups.

func (ListGroupsResponse) MarshalJSON added in v0.17.0 

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

type ListIdpCredentialsResponse added in v0.100.0 

type ListIdpCredentialsResponse struct {
	// IdpCredentials: The IdpCredentials from the specified InboundSamlSsoProfile.
	IdpCredentials []*IdpCredential `json:"idpCredentials,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "IdpCredentials") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IdpCredentials") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListIdpCredentialsResponse: Response of the InboundSamlSsoProfilesService.ListIdpCredentials method.

func (ListIdpCredentialsResponse) MarshalJSON added in v0.100.0 

func (s ListIdpCredentialsResponse) MarshalJSON() ([]byte, error)

type ListInboundSamlSsoProfilesResponse added in v0.100.0 

type ListInboundSamlSsoProfilesResponse struct {
	// InboundSamlSsoProfiles: List of InboundSamlSsoProfiles.
	InboundSamlSsoProfiles []*InboundSamlSsoProfile `json:"inboundSamlSsoProfiles,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "InboundSamlSsoProfiles") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InboundSamlSsoProfiles") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListInboundSamlSsoProfilesResponse: Response of the InboundSamlSsoProfilesService.ListInboundSamlSsoProfiles method.

func (ListInboundSamlSsoProfilesResponse) MarshalJSON added in v0.100.0 

func (s ListInboundSamlSsoProfilesResponse) MarshalJSON() ([]byte, error)

type ListInboundSsoAssignmentsResponse added in v0.100.0 

type ListInboundSsoAssignmentsResponse struct {
	// InboundSsoAssignments: The assignments.
	InboundSsoAssignments []*InboundSsoAssignment `json:"inboundSsoAssignments,omitempty"`
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is omitted, there are no subsequent pages.
	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. "InboundSsoAssignments") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InboundSsoAssignments") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListInboundSsoAssignmentsResponse: Response of the InboundSsoAssignmentsService.ListInboundSsoAssignments method.

func (ListInboundSsoAssignmentsResponse) MarshalJSON added in v0.100.0 

func (s ListInboundSsoAssignmentsResponse) 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListMembershipsResponse: The response message for MembershipsService.ListMemberships.

func (ListMembershipsResponse) MarshalJSON 

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

type ListOrgMembershipsResponse added in v0.67.0 

type ListOrgMembershipsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is empty, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// OrgMemberships: The non-vacuous membership in an orgUnit.
	OrgMemberships []*OrgMembership `json:"orgMemberships,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOrgMembershipsResponse: The response message for OrgMembershipsService.ListOrgMemberships.

func (ListOrgMembershipsResponse) MarshalJSON added in v0.67.0 

func (s ListOrgMembershipsResponse) MarshalJSON() ([]byte, error)

type ListPoliciesResponse added in v0.203.0 

type ListPoliciesResponse struct {
	// NextPageToken: The pagination token to retrieve the next page of results. If
	// this field is empty, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Policies: The results
	Policies []*Policy `json:"policies,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListPoliciesResponse: The response message for PoliciesService.ListPolicies.

func (ListPoliciesResponse) MarshalJSON added in v0.203.0 

func (s ListPoliciesResponse) MarshalJSON() ([]byte, error)

type ListUserInvitationsResponse added in v0.42.0 

type ListUserInvitationsResponse struct {
	// NextPageToken: The token for the next page. If not empty, indicates that
	// there may be more `UserInvitation` resources that match the listing request;
	// this value can be used in a subsequent ListUserInvitationsRequest to get
	// continued results with the current list call.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// UserInvitations: The list of UserInvitation resources.
	UserInvitations []*UserInvitation `json:"userInvitations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListUserInvitationsResponse: Response message for UserInvitation listing request.

func (ListUserInvitationsResponse) MarshalJSON added in v0.42.0 

func (s ListUserInvitationsResponse) MarshalJSON() ([]byte, error)

type LookupGroupNameResponse 

type LookupGroupNameResponse struct {
	// Name: Output only. 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

LookupMembershipNameResponse: The response message for MembershipsService.LookupMembershipName.

func (LookupMembershipNameResponse) MarshalJSON 

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

type LookupSelfDeviceUsersResponse added in v0.22.0 

type LookupSelfDeviceUsersResponse struct {
	// Customer: The 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (LookupSelfDeviceUsersResponse) MarshalJSON added in v0.22.0 

func (s LookupSelfDeviceUsersResponse) MarshalJSON() ([]byte, error)

type MemberRelation added in v0.33.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 membership.
	//
	// 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MemberRelation: Message representing a transitive membership of a group.

func (MemberRelation) MarshalJSON added in v0.33.0 

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

type MemberRestriction added in v0.59.0 

type MemberRestriction struct {
	// Evaluation: The evaluated state of this restriction on a group.
	Evaluation *RestrictionEvaluation `json:"evaluation,omitempty"`
	// Query: Member Restriction as defined by CEL expression. Supported
	// restrictions are: `member.customer_id` and `member.type`. Valid values for
	// `member.type` are `1`, `2` and `3`. They correspond to USER,
	// SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id`
	// only supports `groupCustomerId()` currently which means the customer id of
	// the group will be used for restriction. Supported operators are `&&`, `||`
	// and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service
	// accounts of given customer to be members. `member.type == 2 &&
	// member.customer_id == groupCustomerId()` Allow only users or groups to be
	// members. `member.type == 1 || member.type == 3`
	Query string `json:"query,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Evaluation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Evaluation") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MemberRestriction: The definition of MemberRestriction

func (MemberRestriction) MarshalJSON added in v0.59.0 

func (s MemberRestriction) MarshalJSON() ([]byte, error)

type Membership 

type Membership struct {
	// CreateTime: Output only. The time when the `Membership` was created.
	CreateTime string `json:"createTime,omitempty"`
	// DeliverySetting: Output only. Delivery setting associated with the
	// membership.
	//
	// Possible values:
	//   "DELIVERY_SETTING_UNSPECIFIED" - Default. Should not be used.
	//   "ALL_MAIL" - Represents each mail should be delivered
	//   "DIGEST" - Represents 1 email for every 25 messages.
	//   "DAILY" - Represents daily summary of messages.
	//   "NONE" - Represents no delivery.
	//   "DISABLED" - Represents disabled state.
	DeliverySetting string `json:"deliverySetting,omitempty"`
	// MemberKey: Immutable. The `EntityKey` of the member. Either `member_key` or
	// `preferred_member_key` must be set when calling
	// MembershipsService.CreateMembership but not both; both shall be set when
	// returned.
	MemberKey *EntityKey `json:"memberKey,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.
	// Either `member_key` or `preferred_member_key` must be set when calling
	// MembershipsService.CreateMembership but not both; both shall be set when
	// returned.
	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.
	//   "CBCM_BROWSER" - Represents a CBCM-managed Chrome Browser type.
	//   "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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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.21.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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (MembershipAdjacencyList) MarshalJSON added in v0.21.0 

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

type MembershipRelation added in v0.115.0 

type MembershipRelation struct {
	// Description: An extended description to help users determine the purpose of
	// a `Group`.
	Description string `json:"description,omitempty"`
	// DisplayName: The display name of the `Group`.
	DisplayName string `json:"displayName,omitempty"`
	// Group: The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall
	// be of the form `groups/{group_id}`.
	Group string `json:"group,omitempty"`
	// GroupKey: The `EntityKey` of the `Group`.
	GroupKey *EntityKey `json:"groupKey,omitempty"`
	// Labels: One or more label entries that apply to the Group. Currently
	// supported labels contain a key with an empty value.
	Labels map[string]string `json:"labels,omitempty"`
	// Membership: 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}`.
	Membership string `json:"membership,omitempty"`
	// Roles: The `MembershipRole`s that apply to the `Membership`.
	Roles []*MembershipRole `json:"roles,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MembershipRelation: Message containing membership relation.

func (MembershipRelation) MarshalJSON added in v0.115.0 

func (s MembershipRelation) 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"`
	// RestrictionEvaluations: Evaluations of restrictions applied to parent group
	// on this membership.
	RestrictionEvaluations *RestrictionEvaluations `json:"restrictionEvaluations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExpiryDetail") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 MembershipRoleRestrictionEvaluation added in v0.59.0 

type MembershipRoleRestrictionEvaluation struct {
	// State: Output only. The current state of the restriction
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default. Should not be used.
	//   "COMPLIANT" - The member adheres to the parent group's restriction.
	//   "FORWARD_COMPLIANT" - The group-group membership might be currently
	// violating some parent group's restriction but in future, it will never allow
	// any new member in the child group which can violate parent group's
	// restriction.
	//   "NON_COMPLIANT" - The member violates the parent group's restriction.
	//   "EVALUATING" - The state of the membership is under evaluation.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MembershipRoleRestrictionEvaluation: The evaluated state of this restriction.

func (MembershipRoleRestrictionEvaluation) MarshalJSON added in v0.59.0 

func (s MembershipRoleRestrictionEvaluation) MarshalJSON() ([]byte, error)

type ModifyMembershipRolesRequest added in v0.17.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ModifyMembershipRolesRequest: The request message for MembershipsService.ModifyMembershipRoles.

func (ModifyMembershipRolesRequest) MarshalJSON added in v0.17.0 

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

type ModifyMembershipRolesResponse added in v0.17.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ModifyMembershipRolesResponse: The response message for MembershipsService.ModifyMembershipRoles.

func (ModifyMembershipRolesResponse) MarshalJSON added in v0.17.0 

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

type MoveOrgMembershipRequest added in v0.67.0 

type MoveOrgMembershipRequest struct {
	// Customer: Required. Immutable. Customer on whose membership change is made.
	// All authorization will happen on the role assignments of this customer.
	// Format: customers/{$customerId} where `$customerId` is the `id` from the
	// Admin SDK `Customer` resource
	// (https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers).
	// You may also use `customers/my_customer` to specify your own organization.
	Customer string `json:"customer,omitempty"`
	// DestinationOrgUnit: Required. Immutable. OrgUnit where the membership will
	// be moved to. Format: orgUnits/{$orgUnitId} where `$orgUnitId` is the
	// `orgUnitId` from the Admin SDK `OrgUnit` resource
	// (https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits).
	DestinationOrgUnit string `json:"destinationOrgUnit,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

MoveOrgMembershipRequest: The request message for OrgMembershipsService.MoveOrgMembership.

func (MoveOrgMembershipRequest) MarshalJSON added in v0.67.0 

func (s MoveOrgMembershipRequest) 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, successful response of the operation. 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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 OrgMembership added in v0.67.0 

type OrgMembership struct {
	// Member: Immutable. Org member id as full resource name. Format for shared
	// drive resource: //drive.googleapis.com/drives/{$memberId} where `$memberId`
	// is the `id` from Drive API (V3) `Drive` resource
	// (https://developers.google.com/drive/api/v3/reference/drives#resource).
	Member string `json:"member,omitempty"`
	// MemberUri: Uri with which you can read the member. This follows
	// https://aip.dev/122 Format for shared drive resource:
	// https://drive.googleapis.com/drive/v3/drives/{$memberId} where `$memberId`
	// is the `id` from Drive API (V3) `Drive` resource
	// (https://developers.google.com/drive/api/v3/reference/drives#resource).
	MemberUri string `json:"memberUri,omitempty"`
	// Name: Required. Immutable. The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the OrgMembership.
	// Format: orgUnits/{$orgUnitId}/memberships/{$membership} The `$orgUnitId` is
	// the `orgUnitId` from the Admin SDK `OrgUnit` resource
	// (https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits).
	// The `$membership` shall be of the form `{$entityType};{$memberId}`, where
	// `$entityType` is the enum value of [OrgMembership.EntityType], and
	// `memberId` is the `id` from Drive API (V3) `Drive` resource
	// (https://developers.google.com/drive/api/v3/reference/drives#resource) for
	// OrgMembership.EntityType.SHARED_DRIVE.
	Name string `json:"name,omitempty"`
	// Type: Immutable. Entity type for the org member.
	//
	// Possible values:
	//   "ENTITY_TYPE_UNSPECIFIED" - Equivalent to no resource type mentioned
	//   "SHARED_DRIVE" - Shared drive as resource type
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Member") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

OrgMembership: A membership in an OrgUnit. An `OrgMembership` defines a relationship between an `OrgUnit` and an entity belonging to that `OrgUnit`, referred to as a "member".

func (OrgMembership) MarshalJSON added in v0.67.0 

func (s OrgMembership) MarshalJSON() ([]byte, error)

type OrgUnitsMembershipsListCall added in v0.67.0 

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

func (*OrgUnitsMembershipsListCall) Context added in v0.67.0 

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

Context sets the context to be used in this call's Do method.

func (*OrgUnitsMembershipsListCall) Customer added in v0.67.0 

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

Customer sets the optional parameter "customer": Required. Immutable. Customer that this OrgMembership belongs to. All authorization will happen on the role assignments of this customer. Format: customers/{$customerId} where `$customerId` is the `id` from the Admin SDK `Customer` resource (https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may also use `customers/my_customer` to specify your own organization.

func (*OrgUnitsMembershipsListCall) Do added in v0.67.0 

func (c *OrgUnitsMembershipsListCall) Do(opts ...googleapi.CallOption) (*ListOrgMembershipsResponse, error)

Do executes the "cloudidentity.orgUnits.memberships.list" call. Any non-2xx status code is an error. Response headers are in either *ListOrgMembershipsResponse.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 (*OrgUnitsMembershipsListCall) Fields added in v0.67.0 

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

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

func (*OrgUnitsMembershipsListCall) Filter added in v0.67.0 

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

Filter sets the optional parameter "filter": The search query. Must be specified in Common Expression Language (https://opensource.google/projects/cel). May only contain equality operators on the `type` (e.g., `type == 'shared_drive'`).

func (*OrgUnitsMembershipsListCall) Header added in v0.67.0 

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

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

func (*OrgUnitsMembershipsListCall) IfNoneMatch added in v0.67.0 

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

IfNoneMatch sets an 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.

func (*OrgUnitsMembershipsListCall) PageSize added in v0.67.0 

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

PageSize sets the optional parameter "pageSize": The maximum number of results to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will default to 50. The maximum allowed value is 100, though requests with page_size greater than that will be silently interpreted as 100.

func (*OrgUnitsMembershipsListCall) PageToken added in v0.67.0 

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

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

func (*OrgUnitsMembershipsListCall) Pages added in v0.67.0 

func (c *OrgUnitsMembershipsListCall) Pages(ctx context.Context, f func(*ListOrgMembershipsResponse) 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.

type OrgUnitsMembershipsMoveCall added in v0.67.0 

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

func (*OrgUnitsMembershipsMoveCall) Context added in v0.67.0 

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

Context sets the context to be used in this call's Do method.

func (*OrgUnitsMembershipsMoveCall) Do added in v0.67.0 

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

Do executes the "cloudidentity.orgUnits.memberships.move" call. 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 (*OrgUnitsMembershipsMoveCall) Fields added in v0.67.0 

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

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

func (*OrgUnitsMembershipsMoveCall) Header added in v0.67.0 

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

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

type OrgUnitsMembershipsService added in v0.67.0 

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

func NewOrgUnitsMembershipsService added in v0.67.0 

func NewOrgUnitsMembershipsService(s *Service) *OrgUnitsMembershipsService

func (*OrgUnitsMembershipsService) List added in v0.67.0 

func (r *OrgUnitsMembershipsService) List(parent string) *OrgUnitsMembershipsListCall

List: List OrgMembership resources in an OrgUnit treated as 'parent'. Parent format: orgUnits/{$orgUnitId} where `$orgUnitId` is the `orgUnitId` from the Admin SDK `OrgUnit` resource (https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits)

func (*OrgUnitsMembershipsService) Move added in v0.67.0 

func (r *OrgUnitsMembershipsService) Move(name string, moveorgmembershiprequest *MoveOrgMembershipRequest) *OrgUnitsMembershipsMoveCall

Move: Move an OrgMembership to a new OrgUnit. NOTE: This is an atomic copy-and-delete. The resource will have a new copy under the destination OrgUnit and be deleted from the source OrgUnit. The resource can only be searched under the destination OrgUnit afterwards.

type OrgUnitsService added in v0.67.0 

type OrgUnitsService struct {
	Memberships *OrgUnitsMembershipsService
	// contains filtered or unexported fields
}

func NewOrgUnitsService added in v0.67.0 

func NewOrgUnitsService(s *Service) *OrgUnitsService

type PoliciesGetCall added in v0.203.0 

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

func (*PoliciesGetCall) Context added in v0.203.0 

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

Context sets the context to be used in this call's Do method.

func (*PoliciesGetCall) Do added in v0.203.0 

func (c *PoliciesGetCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "cloudidentity.policies.get" call. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*PoliciesGetCall) Fields added in v0.203.0 

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

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

func (*PoliciesGetCall) Header added in v0.203.0 

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

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

func (*PoliciesGetCall) IfNoneMatch added in v0.203.0 

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

IfNoneMatch sets an 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.

type PoliciesListCall added in v0.203.0 

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

func (*PoliciesListCall) Context added in v0.203.0 

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

Context sets the context to be used in this call's Do method.

func (*PoliciesListCall) Do added in v0.203.0 

func (c *PoliciesListCall) Do(opts ...googleapi.CallOption) (*ListPoliciesResponse, error)

Do executes the "cloudidentity.policies.list" call. Any non-2xx status code is an error. Response headers are in either *ListPoliciesResponse.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 (*PoliciesListCall) Fields added in v0.203.0 

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

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

func (*PoliciesListCall) Filter added in v0.203.0 

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

Filter sets the optional parameter "filter": A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.name = 'settings/gmail.*' Policies can be filtered by setting type with this expression: setting.name = '*.service_status' A maximum of one of the above setting.name clauses can be used. Policies can be filtered by customer with this expression: customer = "customers/{customer}" Where `customer` is the `id` from the Admin SDK `Customer` resource (https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.

func (*PoliciesListCall) Header added in v0.203.0 

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

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

func (*PoliciesListCall) IfNoneMatch added in v0.203.0 

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

IfNoneMatch sets an 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.

func (*PoliciesListCall) PageSize added in v0.203.0 

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

PageSize sets the optional parameter "pageSize": The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100.

func (*PoliciesListCall) PageToken added in v0.203.0 

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

PageToken sets the optional parameter "pageToken": The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token.

func (*PoliciesListCall) Pages added in v0.203.0 

func (c *PoliciesListCall) Pages(ctx context.Context, f func(*ListPoliciesResponse) 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.

type PoliciesService added in v0.203.0 

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

func NewPoliciesService added in v0.203.0 

func NewPoliciesService(s *Service) *PoliciesService

func (*PoliciesService) Get added in v0.203.0 

func (r *PoliciesService) Get(name string) *PoliciesGetCall

Get: Get a Policy

- name: The name of the policy to retrieve. Format: "policies/{policy}".

func (*PoliciesService) List added in v0.203.0 

func (r *PoliciesService) List() *PoliciesListCall

List: List Policies

type Policy added in v0.203.0 

type Policy struct {
	// Customer: Immutable. Customer that the Policy belongs to. The value is in
	// the format 'customers/{customerId}'. The `customerId` must begin with "C" To
	// find your customer ID in Admin Console see
	// https://support.google.com/a/answer/10070793.
	Customer string `json:"customer,omitempty"`
	// Name: Output only. Identifier. The resource name
	// (https://cloud.google.com/apis/design/resource_names) of the Policy. Format:
	// policies/{policy}.
	Name string `json:"name,omitempty"`
	// PolicyQuery: Required. The PolicyQuery the Setting applies to.
	PolicyQuery *PolicyQuery `json:"policyQuery,omitempty"`
	// Setting: Required. The Setting configured by this Policy.
	Setting *Setting `json:"setting,omitempty"`
	// Type: Output only. The type of the policy.
	//
	// Possible values:
	//   "POLICY_TYPE_UNSPECIFIED" - Unspecified policy type.
	//   "SYSTEM" - Policy type denoting the system-configured policies.
	//   "ADMIN" - Policy type denoting the admin-configurable policies.
	Type string `json:"type,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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.

func (Policy) MarshalJSON added in v0.203.0 

func (s Policy) MarshalJSON() ([]byte, error)

type PolicyQuery added in v0.203.0 

type PolicyQuery struct {
	// Group: Immutable. The group that the query applies to. This field is only
	// set if there is a single value for group that satisfies all clauses of the
	// query. If no group applies, this will be the empty string.
	Group string `json:"group,omitempty"`
	// OrgUnit: Required. Immutable. Non-empty default. The OrgUnit the query
	// applies to. This field is only set if there is a single value for org_unit
	// that satisfies all clauses of the query.
	OrgUnit string `json:"orgUnit,omitempty"`
	// Query: Immutable. The CEL query that defines which entities the Policy
	// applies to (ex. a User entity). For details about CEL see
	// https://opensource.google.com/projects/cel. The OrgUnits the Policy applies
	// to are represented by a clause like so: entity.org_units.exists(org_unit,
	// org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy
	// applies to are represented by a clause like so: entity.groups.exists(group,
	// group.group_id == groupId('{groupId}')) The Licenses the Policy applies to
	// are represented by a clause like so: entity.licenses.exists(license, license
	// in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in
	// any combination, and used in conjunction with the &&, || and ! operators.
	// The org_unit and group fields below are helper fields that contain the
	// corresponding value(s) as the query to make the query easier to use.
	Query string `json:"query,omitempty"`
	// SortOrder: Output only. The decimal sort order of this PolicyQuery. The
	// value is relative to all other policies with the same setting type for the
	// customer. (There are no duplicates within this set).
	SortOrder float64 `json:"sortOrder,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Group") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Group") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PolicyQuery: PolicyQuery

func (PolicyQuery) MarshalJSON added in v0.203.0 

func (s PolicyQuery) MarshalJSON() ([]byte, error)

func (*PolicyQuery) UnmarshalJSON added in v0.203.0 

func (s *PolicyQuery) UnmarshalJSON(data []byte) error

type PosixGroup added in v0.50.0 

type PosixGroup struct {
	// Gid: GID of the POSIX group.
	Gid uint64 `json:"gid,omitempty,string"`
	// Name: Name of the POSIX group.
	Name string `json:"name,omitempty"`
	// SystemId: System identifier for which group name and gid apply to. If not
	// specified it will default to empty value.
	SystemId string `json:"systemId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Gid") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Gid") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PosixGroup: POSIX Group definition to represent a group in a POSIX compliant system. Caution: POSIX groups are deprecated. As of September 26, 2024, you can no longer create new POSIX groups. For more information, see https://cloud.google.com/identity/docs/deprecations/posix-groups

func (PosixGroup) MarshalJSON added in v0.50.0 

func (s PosixGroup) MarshalJSON() ([]byte, error)

type RestrictionEvaluation added in v0.59.0 

type RestrictionEvaluation struct {
	// State: Output only. The current state of the restriction
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default. Should not be used.
	//   "EVALUATING" - The restriction state is currently being evaluated.
	//   "COMPLIANT" - All transitive memberships are adhering to restriction.
	//   "FORWARD_COMPLIANT" - Some transitive memberships violate the restriction.
	// No new violating memberships can be added.
	//   "NON_COMPLIANT" - Some transitive memberships violate the restriction. New
	// violating direct memberships will be denied while indirect memberships may
	// be added.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestrictionEvaluation: The evaluated state of this restriction.

func (RestrictionEvaluation) MarshalJSON added in v0.59.0 

func (s RestrictionEvaluation) MarshalJSON() ([]byte, error)

type RestrictionEvaluations added in v0.59.0 

type RestrictionEvaluations struct {
	// MemberRestrictionEvaluation: Evaluation of the member restriction applied to
	// this membership. Empty if the user lacks permission to view the restriction
	// evaluation.
	MemberRestrictionEvaluation *MembershipRoleRestrictionEvaluation `json:"memberRestrictionEvaluation,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "MemberRestrictionEvaluation") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MemberRestrictionEvaluation") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestrictionEvaluations: Evaluations of restrictions applied to parent group on this membership.

func (RestrictionEvaluations) MarshalJSON added in v0.59.0 

func (s RestrictionEvaluations) MarshalJSON() ([]byte, error)

type RsaPublicKeyInfo added in v0.100.0 

type RsaPublicKeyInfo struct {
	// KeySize: Key size in bits (size of the modulus).
	KeySize int64 `json:"keySize,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KeySize") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KeySize") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RsaPublicKeyInfo: Information of a RSA public key.

func (RsaPublicKeyInfo) MarshalJSON added in v0.100.0 

func (s RsaPublicKeyInfo) MarshalJSON() ([]byte, error)

type SamlIdpConfig added in v0.100.0 

type SamlIdpConfig struct {
	// ChangePasswordUri: The **Change Password URL** of the identity provider.
	// Users will be sent to this URL when changing their passwords at
	// `myaccount.google.com`. This takes precedence over the change password URL
	// configured at customer-level. Must use `HTTPS`.
	ChangePasswordUri string `json:"changePasswordUri,omitempty"`
	// EntityId: Required. The SAML **Entity ID** of the identity provider.
	EntityId string `json:"entityId,omitempty"`
	// LogoutRedirectUri: The **Logout Redirect URL** (sign-out page URL) of the
	// identity provider. When a user clicks the sign-out link on a Google page,
	// they will be redirected to this URL. This is a pure redirect with no
	// attached SAML `LogoutRequest` i.e. SAML single logout is not supported. Must
	// use `HTTPS`.
	LogoutRedirectUri string `json:"logoutRedirectUri,omitempty"`
	// SingleSignOnServiceUri: Required. The `SingleSignOnService` endpoint
	// location (sign-in page URL) of the identity provider. This is the URL where
	// the `AuthnRequest` will be sent. Must use `HTTPS`. Assumed to accept the
	// `HTTP-Redirect` binding.
	SingleSignOnServiceUri string `json:"singleSignOnServiceUri,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ChangePasswordUri") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ChangePasswordUri") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SamlIdpConfig: SAML IDP (identity provider) configuration.

func (SamlIdpConfig) MarshalJSON added in v0.100.0 

func (s SamlIdpConfig) MarshalJSON() ([]byte, error)

type SamlSpConfig added in v0.100.0 

type SamlSpConfig struct {
	// AssertionConsumerServiceUri: Output only. The SAML **Assertion Consumer
	// Service (ACS) URL** to be used for the IDP-initiated login. Assumed to
	// accept response messages via the `HTTP-POST` binding.
	AssertionConsumerServiceUri string `json:"assertionConsumerServiceUri,omitempty"`
	// EntityId: Output only. The SAML **Entity ID** for this service provider.
	EntityId string `json:"entityId,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "AssertionConsumerServiceUri") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
	// for more details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AssertionConsumerServiceUri") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SamlSpConfig: SAML SP (service provider) configuration.

func (SamlSpConfig) MarshalJSON added in v0.100.0 

func (s SamlSpConfig) MarshalJSON() ([]byte, error)

type SamlSsoInfo added in v0.100.0 

type SamlSsoInfo struct {
	// InboundSamlSsoProfile: Required. Name of the `InboundSamlSsoProfile` to use.
	// Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`.
	InboundSamlSsoProfile string `json:"inboundSamlSsoProfile,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InboundSamlSsoProfile") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InboundSamlSsoProfile") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SamlSsoInfo: Details that are applicable when `sso_mode` == `SAML_SSO`.

func (SamlSsoInfo) MarshalJSON added in v0.100.0 

func (s SamlSsoInfo) MarshalJSON() ([]byte, error)

type SearchDirectGroupsResponse added in v0.115.0 

type SearchDirectGroupsResponse struct {
	// Memberships: List of direct groups satisfying the query.
	Memberships []*MembershipRelation `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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SearchDirectGroupsResponse: The response message for MembershipsService.SearchDirectGroups.

func (SearchDirectGroupsResponse) MarshalJSON added in v0.115.0 

func (s SearchDirectGroupsResponse) 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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SearchGroupsResponse: The response message for GroupsService.SearchGroups.

func (SearchGroupsResponse) MarshalJSON 

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

type SearchTransitiveGroupsResponse added in v0.33.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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SearchTransitiveGroupsResponse: The response message for MembershipsService.SearchTransitiveGroups.

func (SearchTransitiveGroupsResponse) MarshalJSON added in v0.33.0 

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

type SearchTransitiveMembershipsResponse added in v0.33.0 

type SearchTransitiveMembershipsResponse struct {
	// Memberships: List of transitive memberships 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SearchTransitiveMembershipsResponse: The response message for MembershipsService.SearchTransitiveMemberships.

func (SearchTransitiveMembershipsResponse) MarshalJSON added in v0.33.0 

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

type SecuritySettings added in v0.59.0 

type SecuritySettings struct {
	// MemberRestriction: The Member Restriction value
	MemberRestriction *MemberRestriction `json:"memberRestriction,omitempty"`
	// Name: Output only. The resource name of the security settings. Shall be of
	// the form `groups/{group_id}/securitySettings`.
	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. "MemberRestriction") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MemberRestriction") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SecuritySettings: The definiion of security settings.

func (SecuritySettings) MarshalJSON added in v0.59.0 

func (s SecuritySettings) MarshalJSON() ([]byte, error)

type SendUserInvitationRequest added in v0.42.0 

type SendUserInvitationRequest struct {
}

SendUserInvitationRequest: A request to send email for inviting target user corresponding to the UserInvitation.

type Service 

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

	Customers *CustomersService

	Devices *DevicesService

	Groups *GroupsService

	InboundSamlSsoProfiles *InboundSamlSsoProfilesService

	InboundSsoAssignments *InboundSsoAssignmentsService

	OrgUnits *OrgUnitsService

	Policies *PoliciesService
	// 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 Setting added in v0.203.0 

type Setting struct {
	// Type: Required. Immutable. The type of the Setting. .
	Type string `json:"type,omitempty"`
	// Value: Required. The value of the Setting.
	Value googleapi.RawMessage `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Type") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Setting: Setting

func (Setting) MarshalJSON added in v0.203.0 

func (s Setting) MarshalJSON() ([]byte, error)

type SignInBehavior added in v0.100.0 

type SignInBehavior struct {
	// RedirectCondition: When to redirect sign-ins to the IdP.
	//
	// Possible values:
	//   "REDIRECT_CONDITION_UNSPECIFIED" - Default and means "always"
	//   "NEVER" - Sign-in flows where the user is prompted for their identity will
	// not redirect to the IdP (so the user will most likely be prompted by Google
	// for a password), but special flows like IdP-initiated SAML and sign-in
	// following automatic redirection to the IdP by domain-specific service URLs
	// will accept the IdP's assertion of the user's identity.
	RedirectCondition string `json:"redirectCondition,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RedirectCondition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RedirectCondition") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SignInBehavior: Controls sign-in behavior.

func (SignInBehavior) MarshalJSON added in v0.100.0 

func (s SignInBehavior) MarshalJSON() ([]byte, error)

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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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.33.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 or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TransitiveMembershipRole: Message representing the role of a TransitiveMembership.

func (TransitiveMembershipRole) MarshalJSON added in v0.33.0 

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

type UpdateInboundSamlSsoProfileOperationMetadata added in v0.100.0 

type UpdateInboundSamlSsoProfileOperationMetadata struct {
	// State: State of this Operation Will be "awaiting-multi-party-approval" when
	// the operation is deferred due to the target customer having enabled
	// Multi-party approval for sensitive actions
	// (https://support.google.com/a/answer/13790448).
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateInboundSamlSsoProfileOperationMetadata: LRO response metadata for InboundSamlSsoProfilesService.UpdateInboundSamlSsoProfile.

func (UpdateInboundSamlSsoProfileOperationMetadata) MarshalJSON added in v0.185.0 

func (s UpdateInboundSamlSsoProfileOperationMetadata) MarshalJSON() ([]byte, error)

type UpdateInboundSsoAssignmentOperationMetadata added in v0.100.0 

type UpdateInboundSsoAssignmentOperationMetadata struct {
}

UpdateInboundSsoAssignmentOperationMetadata: LRO response metadata for InboundSsoAssignmentsService.UpdateInboundSsoAssignment.

type UpdateMembershipRolesParams added in v0.17.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`
	// `MembershipRoles` can currently be updated. May only contain a
	// `MembershipRole` with `name` `MEMBER`.
	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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (UpdateMembershipRolesParams) MarshalJSON added in v0.17.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"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "MailsSentCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	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)

type WipeDeviceRequest added in v0.31.0 

type WipeDeviceRequest 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"`
	// RemoveResetLock: Optional. Specifies if a user is able to factory reset a
	// device after a Device Wipe. On iOS, this is called "Activation Lock", while
	// on Android, this is known as "Factory Reset Protection". If true, this
	// protection will be removed from the device, so that a user can successfully
	// factory reset. If false, the setting is untouched on the device.
	RemoveResetLock bool `json:"removeResetLock,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Customer") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (WipeDeviceRequest) MarshalJSON added in v0.31.0 

func (s WipeDeviceRequest) MarshalJSON() ([]byte, error)

type WipeDeviceResponse added in v0.22.0 

type WipeDeviceResponse struct {
	// Device: Resultant Device object for the action. Note that asset tags will
	// not be returned in the device object.
	Device *Device `json:"device,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Device") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (WipeDeviceResponse) MarshalJSON added in v0.22.0 

func (s WipeDeviceResponse) MarshalJSON() ([]byte, error)

type WipeDeviceUserRequest added in v0.31.0 

type WipeDeviceUserRequest 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 or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (WipeDeviceUserRequest) MarshalJSON added in v0.31.0 

func (s WipeDeviceUserRequest) MarshalJSON() ([]byte, error)

type WipeDeviceUserResponse added in v0.22.0 

type WipeDeviceUserResponse struct {
	// DeviceUser: Resultant DeviceUser object for the action.
	DeviceUser *DeviceUser `json:"deviceUser,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeviceUser") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	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. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (WipeDeviceUserResponse) MarshalJSON added in v0.22.0 

func (s WipeDeviceUserResponse) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.