Google Adapter Actions Reference

The RapidIdentity Release versions include updated nomenclature of the Google actions to align with Google's renaming of Google Apps to G-Suite.

The adapter is now referred to as G-Suite and the actions all have "Apps" removed from their names. RapidIdentity includes a mapping from the older G-Suite action names to the newer G-Suite action names.

addGoogleGroupAlias

Add a G-Suite Alias to a Group.

result =
                addGoogleGroupAlias(sessionGoogle, "test-group@example.com",
                "test-group-alias@example.com")

addGoogleGroupMember

Add a member to a G-Suite Group.

result =
                addGoogleGroupMember(sessionGoogle, "test-group@example.com",
                "joeuser@example.com", "MEMBER")

addGoogleGroupMembers

Add a batch of members to a G-Suite Group.

members = createArray()
                appendArrayItem(members, "joeuser@example.com")
                appendArrayItem(members, "freduser@example.com")
                appendArrayItem(members, "tomuser@example.com")
                result = addGoogleGroupMembers(sessionGoogle, "test-group@example.com",
                members, "MEMBER")

addGoogleUserAlias

Add a G-Suite Alias to a User.

result =
                addGoogleUserAlias(sessionGoogle, "joeuser@example.com",
                "joeuser@students.example.com")

callGoogleAPI

Call an arbitrary Google API endpoint.

Global.GoogleDomain = "example.com"
                Global.GoogleOAuthCredentialName = "MyGoogleExtendedCredential"
                sessionGoogle = defineGoogleExtendedOAuthConnection(Global.GoogleDomain,
                Global.MyGoogleExtendedCredential,
                ["https://www.googleapis.com/auth/drive"], currentUser.id)
                # upload test string as a file to google drive
                response = callGoogleAPI(sessionGoogle, "POST",
                "https://www.googleapis.com/upload/drive/v3/files?uploadType=media",
                null, "This is a test", "text/plain");
                # if successfully uploaded, rename from auto-generated name to
                one of our choice
                if(response.statusCode == 200 && response.data && response.data.id)
                {
                fileId = response.data.id
                response = callGoogleAPI(sessionGoogle, "PATCH",
                "https://www.googleapis.com/drive/v3/files/" + fileId, null,
                {name: "text.txt"}, "application/json");
                } else {
                }

defineGoogleExtendedOAuthConnection

Define an Extended OAuth2 connection to G-Suite.

Global.GoogleDomain = "example.com"
                Global.GoogleOAuthCredentialName = "MyGoogleExtendedCredential"
                sessionGoogle = defineGoogleExtendedOAuthConnection(Global.GoogleDomain,
                Global.MyGoogleExtendedCredential,
                ["https://www.googleapis.com/auth/drive"], currentUser.id)

defineGoogleOAuthConnection

Define an OAuth2 connection to G-Suite.

Global.GoogleDomain = "example.com"
                Global.GoogleOAuthCredentialName = "MyGoogleCredential"
                sessionGoogle = defineGoogleOAuthConnection(Global.GoogleDomain,
                Global.GoogleOAuthCredentialName)

deleteGoogleCalendarResource

Delete a G-Suite Calendar Resource record by Id.

deleteGoogleCalendarTrustee

Delete a trustee from a G-Suite Calendar.

result =
                deleteGoogleCalendarTrustee(sessionGoogle, "jdoe@example.com",
                "jsmith@example.com")

deleteGoogleCustomSchema

Delete a G-Suite Custom Schema record by Id.

deleteGoogleGroup

Delete a G-Suite Group record by Id.

result = deleteGoogleGroup(sessionGoogle,
                "test-group@example.com")

deleteGoogleGroupAlias

Delete a G-Suite Alias from a Group.

deleteGoogleGroupMember

Delete a member from a G-Suite Group.

result =
                deleteGoogleGroupMember(sessionGoogle, "test-group@example.com",
                "joeuser@example.com")

deleteGoogleGroupMembers

Delete a batch of members from a G-Suite Group.

members = createArray()
                appendArrayItem(members, "joeuser@example.com")
                appendArrayItem(members, "freduser@example.com")
                appendArrayItem(members, "tomuser@example.com")
                result = deleteGoogleGroupMembers(sessionGoogle, "test-group@example.com",
                members)

deleteGoogleGroups

Delete a batch of G-Suite Group records by Id.

groups = createArray()
                appendArrayItem(groups, "test-group1@example.com")
                appendArrayItem(groups, "test-group2@example.com")
                appendArrayItem(groups, "test-group3@example.com")
                result = deleteGoogleGroups(sessionGoogle, groups)

deleteGoogleOrgUnit

Delete a G-Suite OrgUnit record by Id.

deleteGoogleSharedContact

Delete a G-Suite Shared Contact record by Id.

deleteGoogleSharedContactPhoto

Delete a G-Suite Shared Contact Photo by Id.

deleteGoogleUser

Delete a G-Suite User record by Id.

deleteGoogleUserAlias

Delete a G-Suite Alias from a User.

deleteGoogleUserPhoto

Delete a G-Suite User Photo by Id.

deleteGoogleUsers

Delete a batch of G-Suite Users by Id.

users = createArray()
                appendArrayItem(users, "joeuser@example.com")
                appendArrayItem(users, "freduser@example.com")
                appendArrayItem(users, "tomuser@example.com")
                result = deleteGoogleUsers(sessionGoogle, users)

deleteGoogleUserSendAsAlias

Delete a Send-as Alias for a Google Apps user.

getGoogleCalendarResource

Get a G-Suite Calendar Resource record by Id.

resource =
                getGoogleCalendarResource(sessionGoogle,
                "testresource_1393275428627")

getGoogleCalendarResources

Get G-Suite Calendar Resource records.

getGoogleCalendarTrustee

Get a trustee of the G-Suite Calendar.

trustee =
                getGoogleCalendarTrustee(sessionGoogle, "jdoe@example.com",
                "example.com")

getGoogleCalendarTrustees

Get G-Suite Calendar trustees.

getGoogleCustomSchema

Get a G-Suite CustomSchema record by Id.

getGoogleCustomSchemas

Get G-Suite Custom Schema records.

getGoogleGroup

Get a G-Suite Group record by Id.

groupIds = createArray()
                getGoogleGroup(groupIds, "group1@example.com")
                getGoogleGroup(groupIds, "group2@example.com")
                getGoogleGroup(groupIds, "group3@example.com")
                groups = getGoogleGroupsById(sessionGoogle, groupIds)

getGoogleGroups

Get G-Suite Group records.

getGoogleGroupsById

Get batch of G-Suite Group records by Id.

group =
                getGoogleGroupsById(sessionGoogle,
                "testgroup_1332876583247@example.com")

getGoogleGroupSettings

Get a G-Suite Group Settings record.

groupSettings =
                getGoogleGroupSettings(sessionGoogle,
                "testgroup_1332876583247@example.com")

getGoogleOrgUnit

Get a G-Suite OrgUnit record by Id.

getGoogleOrgUnits

Get G-Suite OrgUnit records.

getGoogleSharedContact

Get a G-Suite Shared Contact record by Id.

getGoogleSharedContactPhoto

Get a G-Suite Shared Contact Photo by Id.

getGoogleSharedContacts

Get G-Suite Shared Contact records.

getGoogleUser

Get a G-Suite User record by Id.

getGoogleUserPhoto

Get a G-Suite User Photo by Id.

getGoogleUsers

Get G-Suite User records.

getGoogleUsersById

Get batch of G-Suite User records by Id.

userIds = createArray()
                appendArrayElement(userIds, "user1@example.com")
                appendArrayElement(userIds, "user2@example.com")
                appendArrayElement(userIds, "user3@example.com")
                users = getGoogleUsersById(sessionGoogle, userIds)

getGoogleUserSendAsAlias

Get the specific Send-As Alias for a Google User.

getGoogleUserSendAsAliases

Get the Send-as Aliases for a G-Suite User.

openGoogleCalendarResourceIterator

Open G-Suite Calendar Resource Iterator.

iterator =
                openGoogleCalendarResourceIterator(conn, true)
                forEach(next, iterator) {
                log("next:" + next);
                }
                close(iterator)

openGoogleGroupIterator

Open G-Suite Group Iterator.

iterator = openGoogleGroupIterator(conn,
                true)
                forEach(next, iterator) {
                log("next:" + next);
                }
                close(iterator)

openGoogleOrgUnitIterator

Open G-Suite OrgUnit Iterator.

iterator =
                openGoogleOrgUnitIterator(conn, true)
                forEach(next, iterator) {
                log("next:" + next);
                }
                close(iterator)

openGoogleSharedContactIterator

Open G-Suite Shared Contact Iterator.

iterator =
                openGoogleSharedContactIterator(conn, true)
                forEach(next, iterator) {
                log("next:" + next);
                }
                close(iterator)

openGoogleUserIterator

Open G-Suite User Iterator.

iterator = openGoogleUserIterator(conn,
                true)
                forEach(next, iterator) {
                log("next:" + next);
                }
                close(iterator)

saveGoogleCalendarResource

Update a G-Suite Calendar Resource record.

resource = createRecord(false)
                setRecordFieldValue(resource, "resourceId", "projector-1")
                setRecordFieldValue(resource, "resourceDescription",
                "Dell model 1021 projector - Sales")
                setRecordFieldValue(resource, "resourceName", "projector-sales")
                result = saveGoogleCalendarResource(sessionGoogle, resource)

saveGoogleCustomSchema

Create/Update a G-Suite Custom Schema record.

schemaTemplate = createRecordFromObject({
                schemaName: "my_schema",
                fields: [
                {
                fieldName: "isManager",
                fieldType: "BOOL",
                indexed: false,
                multiValued: false,
                readAccessType: "ALL_DOMAIN_USERS"
                },
                {
                fieldName: "directReports",
                fieldType: "EMAIL",
                indexed: true,
                multiValued: true,
                readAccessType: "ALL_DOMAIN_USERS"
                },
                ]
                })
                my_schema = saveGoogleCustomSchema(conn, schemaTemplate)

saveGoogleGroup

Create/Update a G-Suite Group record.

group = createRecord(false)
                setRecordFieldValue(group, "groupId", "test-group@example.com")
                setRecordFieldValue(group, "groupName", "test-group")
                setRecordFieldValue(group, "description", "A test group")
                result = saveGoogleGroup(sessionGoogle, group)

saveGoogleGroups

Create/Update a batch of G-Suite Group records.

groups = createArray()
                i = 0
                while(i++ < 5) {
                group = createRecord(false)
                setRecordFieldValue(group, "groupId", "test-group-" + i + "@example.com")
                setRecordFieldValue(group, "groupName", "test-group-" + i);
                setRecordFieldValue(group, "description", "A test group")
                appendArrayItem(groups, group)
                }
                result = saveGoogleGroups(sessionGoogle, groups)

saveGoogleGroupSettings

Update a G-Suite Group Settings record.

groupSettings = createRecord(false)
                setRecordFieldValue(groupSettings, "id", "test-group@example.com")
                setRecordFieldValue(groupSettings, "whoCanPostMessage",
                "ALL_MEMBERS_CAN_POST")
                result = saveGoogleGroupSettings(sessionGoogle, groupSettings)

saveGoogleOrgUnit

Create/Update a G-Suite OrgUnit record.

orgUnit = createRecord(true)
                addRecordFieldValue(orgUnit, "name", "jim-test", false)
                addRecordFieldValue(orgUnit, "description", "Jim's test org unit", false)
                addRecordFieldValue(orgUnit, "parentOrgUnitPath", "/", false)
                saveGoogleOrgUnit(sessionGoogle, orgUnit)
                orgUnit2 = createRecord(false)
                addRecordFieldValue(orgUnit2, "name", "jim-test-sub", false)
                addRecordFieldValue(orgUnit2, "parentOrgUnitPath", "jim-test", false)
                addRecordFieldValue(orgUnit2, "description", "Jim's test sub ou", false)
                addRecordFieldValue(orgUnit2, "blockInheritance", "true", false)
                saveGoogleOrgUnit(sessionGoogle, orgUnit2)

saveGoogleSharedContact

Update a G-Suite Shared Contact record.

phone = createRecord(true)
                addRecordFieldValue(phone, "number", "2812200021", false)
                addRecordFieldValue(phone, "rel", "work", false)
                addRecordFieldValue(phone, "primary", "true", false)
                contact = createRecord(false)
                addRecordFieldValue(contact, "fullName", "Identity Automation", false)
                addRecordFieldValue(contact, "phoneNumber", phone, false)
                result = saveGoogleSharedContact(sessionGoogle, contact)

saveGoogleUser

Create/Update a G-Suite User record.

user = createRecord(true)
                addRecordFieldValue(user, "primaryEmail", "joeuser@example.com", false)
                addRecordFieldValue(user, "password", "Ch@ng3m3", false)
                addRecordFieldValue(user, "familyName", "User", false)
                addRecordFieldValue(user, "givenName", "Joe", false)
                addRecordFieldValue(user, "orgUnitPath", "jim-test", false)
                phone = createRecord(true)
                addRecordFieldValue(phone, "number", "2812200021", false)
                addRecordFieldValue(phone, "rel", "work", false)
                addRecordFieldValue(phone, "primary", "true", false)
                addRecordFieldValue(user, "phones", phone)
                result = saveGoogleUser(sessionGoogle, user)

saveGoogleUsers

Create/Update a batch of G-Suite User records.

users = createArray()
                i = 0
                while(i++ < 5) {
                user = createRecord(true)
                addRecordFieldValue(user, "primaryEmail", "joeuser_" + i +
                "@example.com", false)
                addRecordFieldValue(user, "password", "Ch@ng3m3", false)
                addRecordFieldValue(user, "familyName", "User", false)
                addRecordFieldValue(user, "givenName", "Joe", false)
                addRecordFieldValue(user, "orgUnitPath", "jim-test", false)
                appendArrayItem(users, group)
                }
                result = saveGoogleUsers(sessionGoogle, users)

saveGoogleUserSendAsAlias

Add a Send-as Alias for a Google User.

{
                doesContain = stringContains(exists['emails'], recordAD['mail'], true)
                if (!doesContain) {
                # Add Google Apps Alias
                {
                result = addGoogleUserAlias(sessionGoogle, recordAD['mail'], record['userName'])
                }
                if (result) {
                {
                alias = createRecord()
                setRecordFieldValue(alias, "userId", record['userName'])
                setRecordFieldValue(alias, "address", recordAD['mail'])
                setRecordFieldValue(alias, "name", recordAD['displayName'])
                setRecordFieldValue(alias, "replyTo", recordAD['mail'])
                setRecordFieldValue(alias, "makeDefault", true)
                result = saveGoogleUserSendAsAlias(sessionGoogle, alias)
                }
                } else {
                }
                } else {
                }

setGoogleCalendarTrustee

Add/Update a trustee of a G-Suite Calendar.

result =
                setGoogleCalendarTrustee(sessionGoogle, "jdoe@example.com",
                "jsmith@example.com", "read")

setGoogleSharedContactPhoto

Update a G-Suite Shared Contact Photo.

photo =
                loadFileAsBytes("/photos/test.jpg")
                result = setGoogleSharedContactPhoto(sessionGoogle, "7154f278887c0b81",
                "image/jpeg", photo)

setGoogleUserPhoto

Update a G-Suite User Photo.

photo =
                loadFileAsBytes("/photos/jdoe.jpg")
                result = setGoogleUserPhoto(sessionGoogle, "jdoe@example.com",
                "image/jpeg", photo)