gsmci

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Oct 30, 2023 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Overview

Package gsmci implements the Cloud Identity API

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddSsoProfileIdpCredential added in v0.9.0 

func AddSsoProfileIdpCredential(parent, fields string, request *ci.AddIdpCredentialRequest) (*googleapi.RawMessage, error)

AddSsoProfileIdpCredential adds an IdpCredential. Up to 2 credentials are allowed.

func ApproveDeviceUser added in v0.2.5 

func ApproveDeviceUser(name, fields string, approveDeviceRequest *ci.GoogleAppsCloudidentityDevicesV1ApproveDeviceUserRequest) (*googleapi.RawMessage, error)

ApproveDeviceUser approves device to access user data.

func BlockDeviceUser added in v0.2.5 

func BlockDeviceUser(name, fields string, blockDeviceRequest *ci.GoogleAppsCloudidentityDevicesV1BlockDeviceUserRequest) (*googleapi.RawMessage, error)

BlockDeviceUser blocks device from accessing user data

func CancelDeviceUserWipe added in v0.2.5 

func CancelDeviceUserWipe(name, fields string, cancelWipeRequest *ci.GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserRequest) (*googleapi.RawMessage, error)

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

func CancelDeviceWipe added in v0.2.5 

func CancelDeviceWipe(name, fields string, cancelWipeDeviceRequest *ci.GoogleAppsCloudidentityDevicesV1CancelWipeDeviceRequest) (*googleapi.RawMessage, error)

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

func CancelInvitation added in v0.8.0 

func CancelInvitation(name string, cancelUserInvitationRequest *ci.CancelUserInvitationRequest) (*googleapi.RawMessage, error)

CancelInvitation cancels a UserInvitation that was already sent.

func CheckTransitiveMembership 

func CheckTransitiveMembership(parent, query string) (bool, error)

CheckTransitiveMembership checks a potential member for membership in a group.

func CreateDevice added in v0.2.5 

func CreateDevice(customer, fields string, device *ci.GoogleAppsCloudidentityDevicesV1Device) (*googleapi.RawMessage, error)

CreateDevice creates a device. Only company-owned device may be created.

func CreateGroup 

func CreateGroup(group *ci.Group, initialGroupConfig, fields string) (*googleapi.RawMessage, error)

CreateGroup creates a group.

func CreateMembership 

func CreateMembership(parent, fields string, membership *ci.Membership) (*googleapi.RawMessage, error)

CreateMembership creates a Membership.

func CreateSsoAssignment added in v0.9.0 

func CreateSsoAssignment(fields string, assignment *ci.InboundSsoAssignment) (*googleapi.RawMessage, error)

CreateSsoAssignment creates an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.

func CreateSsoProfile added in v0.9.0 

func CreateSsoProfile(fields string, profile *ci.InboundSamlSsoProfile) (*googleapi.RawMessage, error)

CreateSsoProfile creates an InboundSamlSsoProfile for a customer.

func DeleteDevice added in v0.2.5 

func DeleteDevice(name, customer string) (*googleapi.RawMessage, error)

DeleteDevice deletes the specified device.

func DeleteDeviceUser added in v0.2.5 

func DeleteDeviceUser(name, customer string) (*googleapi.RawMessage, error)

DeleteDeviceUser deletes the specified DeviceUser. This also revokes the user's access to device data.

func DeleteGroup 

func DeleteGroup(name string) (bool, error)

DeleteGroup deletes a group.

func DeleteMembership 

func DeleteMembership(name string) (bool, error)

DeleteMembership deletes a Membership.

func DeleteSsoAssignment added in v0.9.0 

func DeleteSsoAssignment(name string) (bool, error)

DeleteSsoAssignment deletes an InboundSsoAssignment.

func DeleteSsoProfile added in v0.9.0 

func DeleteSsoProfile(name string) (bool, error)

DeleteSsoProfile deletes an InboundSamlSsoProfile.

func DeleteSsoProfileIdpCredential added in v0.9.0 

func DeleteSsoProfileIdpCredential(name string) (bool, error)

DeleteSsoProfileIdpCredential deletes an IdpCredential.

func GetClientState added in v0.2.5 

func GetClientState(name, customer, fields string) (*ci.GoogleAppsCloudidentityDevicesV1ClientState, error)

GetClientState gets the client state for the device user

func GetDevice added in v0.2.5 

func GetDevice(name, customer, fields string) (*ci.GoogleAppsCloudidentityDevicesV1Device, error)

GetDevice retrieves the specified device.

func GetDeviceUser added in v0.2.5 

func GetDeviceUser(name, customer, fields string) (*ci.GoogleAppsCloudidentityDevicesV1DeviceUser, error)

GetDeviceUser retrieves the specified DeviceUser

func GetGroup 

func GetGroup(name, fields string) (*ci.Group, error)

GetGroup retrieves a group.

func GetInvitation added in v0.8.0 

func GetInvitation(name, fields string) (*ci.UserInvitation, error)

GetInvitation retrieves a UserInvitation resource.

func GetMembership 

func GetMembership(name, fields string) (*ci.Membership, error)

GetMembership retrieves a Membership.

func GetMembershipGraph 

func GetMembershipGraph(parent, query, fields string) (*googleapi.RawMessage, error)

GetMembershipGraph gets a membership graph of just a member or both a member and a group. 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.

func GetSecuritySettings added in v0.8.0 

func GetSecuritySettings(name, readMask, fields string) (*ci.SecuritySettings, error)

GetSecuritySettings returns the security settings of a group.

func GetSsoAssignment added in v0.9.0 

func GetSsoAssignment(name, fields string) (*ci.InboundSsoAssignment, error)

GetSsoAssignment gets an InboundSsoAssignment.

func GetSsoProfile added in v0.9.0 

func GetSsoProfile(name, fields string) (*ci.InboundSamlSsoProfile, error)

GetSsoProfile gets an InboundSamlSsoProfile.

func GetSsoProfileIdpCredential added in v0.9.0 

func GetSsoProfileIdpCredential(parent, fields string) (*ci.IdpCredential, error)

GetSsoProfileIdpCredential gets an IdpCredential.

func IsInvitableUser added in v0.8.0 

func IsInvitableUser(name string) (bool, error)

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.

func ListClientStates added in v0.2.5 

func ListClientStates(parent, customer, filter, orderBy, fields string, cap int) (<-chan *ci.GoogleAppsCloudidentityDevicesV1ClientState, <-chan error)

ListClientStates lists the client states for the given search query.

func ListDeviceUsers added in v0.2.5 

func ListDeviceUsers(parent, customer, filter, orderBy, fields string, cap int) (<-chan *ci.GoogleAppsCloudidentityDevicesV1DeviceUser, <-chan error)

ListDeviceUsers lists/searches DeviceUsers.

func ListDevices added in v0.2.5 

func ListDevices(customer, filter, orderBy, view, fields string, cap int) (<-chan *ci.GoogleAppsCloudidentityDevicesV1Device, <-chan error)

ListDevices lists/searches devices.

func ListGroups 

func ListGroups(parent, view, fields string, cap int) (<-chan *ci.Group, <-chan error)

ListGroups retrieves a list of groups

func ListMembers 

func ListMembers(parent, fields, view string, cap int) (<-chan *ci.Membership, <-chan error)

ListMembers lists the members of a group

func ListSsoAssignment added in v0.9.0 

func ListSsoAssignment(filter, fields string, cap int) (<-chan *ci.InboundSsoAssignment, <-chan error)

ListSsoAssignment lists the InboundSsoAssignments for a Customer.

func ListSsoProfileIdpCredential added in v0.9.0 

func ListSsoProfileIdpCredential(parent, fields string, cap int) (<-chan *ci.IdpCredential, <-chan error)

ListSsoProfileIdpCredential returns a list of IdpCredentials in an InboundSamlSsoProfile.

func ListSsoProfiles added in v0.9.0 

func ListSsoProfiles(filter, fields string, cap int) (<-chan *ci.InboundSamlSsoProfile, <-chan error)

ListSsoProfiles retrieves a list of InboundSamlSsoProfile resources.

func ListUserInvitations added in v0.8.0 

func ListUserInvitations(parent, filter, orderBy, fields string, cap int) (<-chan *ci.UserInvitation, <-chan error)

ListUserInvitations retrieves a list of UserInvitation resources.

func LookupDeviceUsers added in v0.2.5 

func LookupDeviceUsers(parent, androidID, rawResourceID, userID, fields string, cap int) (<-chan string, <-chan error)

LookupDeviceUsers 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 'androidId' field is required.
  • Desktop: Specifying the 'rawResourceId' field is required.

func LookupGroup 

func LookupGroup(email string) (string, error)

LookupGroup looks up a group via its email address and returns its resourceName

func LookupMembership 

func LookupMembership(parent, memberKeyID, memberKeyNamespace string) (string, error)

LookupMembership looks up the resource name of a Membership by its EntityKey.

func ModifyMembershipRoles 

func ModifyMembershipRoles(name, fields string, modifyMembershipRolesRequest *ci.ModifyMembershipRolesRequest) (*ci.Membership, error)

ModifyMembershipRoles modifies the MembershipRoles of a Membership.

func PatchClientState added in v0.2.5 

func PatchClientState(name, customer, updateMask, fields string, clientState *ci.GoogleAppsCloudidentityDevicesV1ClientState) (*googleapi.RawMessage, error)

PatchClientState updates the client state for the device user

func PatchGroup 

func PatchGroup(name, updateMask, fields string, group *ci.Group) (*googleapi.RawMessage, error)

PatchGroup updates a group using patch semantics.

func PatchSsoAssignment added in v0.9.0 

func PatchSsoAssignment(name, updateMask, fields string, assignment *ci.InboundSsoAssignment) (*googleapi.RawMessage, error)

PatchSsoAssignment patchs an InboundSsoAssignment for users and devices in a Customer under a given Group or OrgUnit.

func PatchSsoProfile added in v0.9.0 

func PatchSsoProfile(name, updateMask, fields string, profile *ci.InboundSamlSsoProfile) (*googleapi.RawMessage, error)

PatchSsoProfile updates an InboundSamlSsoProfile.

func SearchGroups 

func SearchGroups(query, view, fields string, cap int) (<-chan *ci.Group, <-chan error)

SearchGroups searches for Groups matching a specified query.

func SearchTransitiveGroups 

func SearchTransitiveGroups(parent, query, fields string, cap int) (<-chan *ci.GroupRelation, <-chan error)

SearchTransitiveGroups searches transitive groups of a member.

func SearchTransitiveMemberships 

func SearchTransitiveMemberships(parent, fields string, cap int) (<-chan *ci.MemberRelation, <-chan error)

SearchTransitiveMemberships search transitive memberships of a group.

func SendInvitation added in v0.8.0 

func SendInvitation(name, fields string, sendUserInvitationRequest *ci.SendUserInvitationRequest) (*googleapi.RawMessage, error)

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

func SetClient 

func SetClient(c *http.Client)

SetClient is used to inject a *http.Client into the package

func UpdateSecuritySettings added in v0.8.0 

func UpdateSecuritySettings(name, updateMask, fields string, securitysettings *ci.SecuritySettings) (*googleapi.RawMessage, error)

UpdateSecuritySettings updates the security settings of a group.

func WipeDevice added in v0.2.5 

func WipeDevice(name, fields string, wipeDeviceRequest *ci.GoogleAppsCloudidentityDevicesV1WipeDeviceRequest) (*googleapi.RawMessage, error)

WipeDevice wipes all data on the specified device.

func WipeDeviceUser added in v0.2.5 

func WipeDeviceUser(name, fields string, wipeRequest *ci.GoogleAppsCloudidentityDevicesV1WipeDeviceUserRequest) (*googleapi.RawMessage, error)

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

Types

This section is empty.

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.