Google Workspace · Arazzo Workflow

Google Workspace Rename a Group

Version 1.0.0

Read a group, patch its name and description, then confirm the change.

1 workflow 1 source API 1 provider
View Spec View on GitHub CalendarCollaborationEmailProductivityStorageVideo ConferencingArazzoWorkflows

Provider

google-workspace

Workflows

rename-group
Patch a group's name and description and confirm the update.
Reads the group to confirm it exists, patches the supplied name and description, then re-reads the group to confirm the new values.
3 steps inputs: accessToken, description, groupKey, name outputs: description, groupId, name
1
lookupGroup
getGroup
Read the group by its key to confirm it exists and capture its current name before updating.
2
renameGroup
patchGroup
Patch the group with the new name and description, leaving other properties untouched.
3
confirmRename
getGroup
Read the group back to confirm the new name and description are now set.

Source API Descriptions

Arazzo Workflow Specification

google-workspace-rename-group-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Google Workspace Rename a Group
  summary: Read a group, patch its name and description, then confirm the change.
  description: >-
    Updates the display name and description of an existing group. The workflow
    reads the group to confirm it exists, patches the new name and description
    using patch semantics, and reads it back to confirm the change took effect.
    Every step spells out its request inline so the flow can be read and executed
    without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: directoryApi
  url: ../openapi/admin-sdk-directory-api.yml
  type: openapi
workflows:
- workflowId: rename-group
  summary: Patch a group's name and description and confirm the update.
  description: >-
    Reads the group to confirm it exists, patches the supplied name and
    description, then re-reads the group to confirm the new values.
  inputs:
    type: object
    required:
    - accessToken
    - groupKey
    - name
    properties:
      accessToken:
        type: string
        description: OAuth 2.0 bearer access token with the admin.directory.group scope.
      groupKey:
        type: string
        description: Group email, alias, or unique id of the group to rename.
      name:
        type: string
        description: The new display name for the group.
      description:
        type: string
        description: The new description for the group.
        default: ""
  steps:
  - stepId: lookupGroup
    description: >-
      Read the group by its key to confirm it exists and capture its current
      name before updating.
    operationId: getGroup
    parameters:
    - name: groupKey
      in: path
      value: $inputs.groupKey
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      groupId: $response.body#/id
      currentName: $response.body#/name
  - stepId: renameGroup
    description: >-
      Patch the group with the new name and description, leaving other
      properties untouched.
    operationId: patchGroup
    parameters:
    - name: groupKey
      in: path
      value: $inputs.groupKey
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    requestBody:
      contentType: application/json
      payload:
        name: $inputs.name
        description: $inputs.description
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      groupId: $response.body#/id
      name: $response.body#/name
  - stepId: confirmRename
    description: >-
      Read the group back to confirm the new name and description are now set.
    operationId: getGroup
    parameters:
    - name: groupKey
      in: path
      value: $inputs.groupKey
    - name: Authorization
      in: header
      value: "Bearer $inputs.accessToken"
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      groupId: $response.body#/id
      name: $response.body#/name
      description: $response.body#/description
  outputs:
    groupId: $steps.confirmRename.outputs.groupId
    name: $steps.confirmRename.outputs.name
    description: $steps.confirmRename.outputs.description