Google Admin SDK Admin Sdk Admin Directory Members API

openapi: 3.1.0
info:
  title: Admin SDK API Members API
  version: directory_v1
  description: Generated from Google's published Discovery document for Admin SDK API (admin directory_v1, revision 20261109).
    7 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/workspace/admin/
servers:
- url: https://admin.googleapis.com
paths:
  /admin/directory/v1/groups/{groupKey}/members/{memberKey}:
    get:
      operationId: directory.members.get
      summary: Get members
      description: Retrieves a group member's properties.
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: memberKey
        in: path
        required: true
        description: Identifies the group member in the API request. A group member can be a user or another group. The value
          can be the member's (group or user) primary email address, alias, or unique ID.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
        - https://www.googleapis.com/auth/admin.directory.group.member.readonly
        - https://www.googleapis.com/auth/admin.directory.group.readonly
      - apiKey: []
      tags:
      - Members
    patch:
      operationId: directory.members.patch
      summary: Patch members
      description: Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: memberKey
        in: path
        required: true
        description: Identifies the group member in the API request. A group member can be a user or another group. The value
          can be the member's (group or user) primary email address, alias, or unique ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Member'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        4XX:
          content: &id002
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id002
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
      - apiKey: []
      tags:
      - Members
    delete:
      operationId: directory.members.delete
      summary: Delete members
      description: Removes a member from a group.
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: memberKey
        in: path
        required: true
        description: Identifies the group member in the API request. A group member can be a user or another group. The value
          can be the member's (group or user) primary email address, alias, or unique ID.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        4XX:
          content: &id003
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id003
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
      - apiKey: []
      tags:
      - Members
    put:
      operationId: directory.members.update
      summary: Update members
      description: Updates the membership of a user in the specified group.
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: memberKey
        in: path
        required: true
        description: Identifies the group member in the API request. A group member can be a user or another group. The value
          can be the member's (group or user) primary email address, alias, or unique ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Member'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        4XX:
          content: &id004
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id004
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
      - apiKey: []
      tags:
      - Members
  /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}:
    get:
      operationId: directory.members.hasMember
      summary: Has member members
      description: Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested,
        the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check
        for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership)
        method in the Cloud Identity Groups API.
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: memberKey
        in: path
        required: true
        description: Identifies the user member in the API request. The value can be the user's primary email address, alias,
          or unique ID.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MembersHasMember'
        4XX:
          content: &id005
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id005
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
        - https://www.googleapis.com/auth/admin.directory.group.member.readonly
        - https://www.googleapis.com/auth/admin.directory.group.readonly
      - apiKey: []
      tags:
      - Members
  /admin/directory/v1/groups/{groupKey}/members:
    post:
      operationId: directory.members.insert
      summary: Insert members
      description: Adds a user to the specified group.
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Member'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Member'
        4XX:
          content: &id006
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id006
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
      - apiKey: []
      tags:
      - Members
    get:
      operationId: directory.members.list
      summary: List members
      description: Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more
        information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
      parameters:
      - name: groupKey
        in: path
        required: true
        description: Identifies the group in the API request. The value can be the group's email address, group alias, or
          the unique group ID.
        schema:
          type: string
      - name: includeDerivedMembership
        in: query
        required: false
        description: 'Whether to list indirect memberships. Default: false.'
        schema:
          type: boolean
      - name: maxResults
        in: query
        required: false
        description: Maximum number of results to return. Max allowed value is 200.
        schema:
          format: int32
          minimum: 1
          type: integer
          default: '200'
      - name: pageToken
        in: query
        required: false
        description: Token to specify next page in the list.
        schema:
          type: string
      - name: roles
        in: query
        required: false
        description: The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`,
          `MANAGER`, and `MEMBER`.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Members'
        4XX:
          content: &id007
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id007
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.directory.group
        - https://www.googleapis.com/auth/admin.directory.group.member
        - https://www.googleapis.com/auth/admin.directory.group.member.readonly
        - https://www.googleapis.com/auth/admin.directory.group.readonly
      - apiKey: []
      tags:
      - Members
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/admin.directory.userschema: View and manage the provisioning of user schemas on
              your domain
            https://www.googleapis.com/auth/admin.directory.group.readonly: View groups on your domain
            https://www.googleapis.com/auth/admin.directory.resource.calendar: View and manage the provisioning of calendar
              resources on your domain
            https://www.googleapis.com/auth/admin.directory.domain.readonly: View domains related to your customers
            https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly: View your ChromeOS devices' metadata
            https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly: View calendar resources on your domain
            https://www.googleapis.com/auth/admin.directory.device.mobile.readonly: View your mobile devices' metadata
            https://www.googleapis.com/auth/admin.chrome.printers.readonly: See the printers that your organization can use
              with Chrome
            https://www.googleapis.com/auth/admin.directory.user.alias.readonly: View user aliases on your domain
            https://www.googleapis.com/auth/admin.chrome.printers: See, add, edit, and permanently delete the printers that
              your organization can use with Chrome
            https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly: View delegated admin roles for your domain
            https://www.googleapis.com/auth/admin.directory.user: View and manage the provisioning of users on your domain
            https://www.googleapis.com/auth/admin.directory.group: View and manage the provisioning of groups on your domain
            https://www.googleapis.com/auth/admin.directory.user.readonly: See info about users on your domain
            https://www.googleapis.com/auth/admin.directory.rolemanagement: Manage delegated admin roles for your domain
            https://www.googleapis.com/auth/admin.directory.user.security: Manage data access permissions for users on your
              domain
            https://www.googleapis.com/auth/admin.directory.customer: View and manage customer related information
            https://www.googleapis.com/auth/admin.directory.userschema.readonly: View user schemas on your domain
            https://www.googleapis.com/auth/admin.directory.device.mobile.action: Manage your mobile devices by performing
              administrative tasks
            https://www.googleapis.com/auth/admin.directory.orgunit: View and manage organization units on your domain
            https://www.googleapis.com/auth/admin.directory.group.member: View and manage group subscriptions on your domain
            https://www.googleapis.com/auth/admin.directory.device.chromeos: View and manage your ChromeOS devices' metadata
            https://www.googleapis.com/auth/admin.directory.device.mobile: View and manage your mobile devices' metadata
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see
              the email address for your Google Account.
            https://www.googleapis.com/auth/admin.directory.group.member.readonly: View group subscriptions on your domain
            https://www.googleapis.com/auth/admin.directory.orgunit.readonly: View organization units on your domain
            https://www.googleapis.com/auth/admin.directory.user.alias: View and manage user aliases on your domain
            https://www.googleapis.com/auth/admin.directory.customer.readonly: View customer related information
            https://www.googleapis.com/auth/admin.directory.domain: View and manage the provisioning of domains for your customers
  schemas:
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
    Member:
      description: A Google Groups member can be a user or another group. This member can be inside or outside of your account's
        domains. For more information about common group member tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
      properties:
        kind:
          type: string
          default: admin#directory#member
          description: The type of the API resource. For Members resources, the value is `admin#directory#member`.
        role:
          type: string
          description: The member's role in a group. The API returns an error for cycles in group memberships. For example,
            if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's
            role, see the [administration help center](https://support.google.com/a/answer/167094).
        id:
          type: string
          description: The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
        email:
          description: The member's email address. A member can be a user or another group. This property is required when
            adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address
            is changed, the API automatically reflects the email address changes.
          type: string
        delivery_settings:
          description: Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and
            `get` methods.
          type: string
        etag:
          description: ETag of the resource.
          type: string
        status:
          description: Status of member (Immutable)
          type: string
        type:
          type: string
          description: The type of group member.
      type: object
    Members:
      type: object
      properties:
        etag:
          description: ETag of the resource.
          type: string
        members:
          type: array
          description: A list of member objects.
          items:
            $ref: '#/components/schemas/Member'
        nextPageToken:
          type: string
          description: Token used to access next page of this result.
        kind:
          default: admin#directory#members
          type: string
          description: Kind of resource this is.
    MembersHasMember:
      type: object
      properties:
        isMember:
          type: boolean
          description: Output only. Identifies whether the given user is a member of the group. Membership can be direct or
            nested.
          readOnly: true
      description: JSON template for Has Member response in Directory API.
x-provenance:
  method: harvested
  publisher: Google
  source: https://admin.googleapis.com/$discovery/rest?version=directory_v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261109)