Cisco Directory Connectors Groups API

The Groups API from Cisco Directory Connectors — 2 operation(s) for groups.

OpenAPI Specification

cisco-directory-connectors-groups-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cisco Directory Connectors API (via Webex People & ) Groups API
  description: 'Cisco Directory Connectors synchronize Active Directory or LDAP user

    and group data into Cisco Webex / Control Hub. Programmatic management

    is performed through the Webex People and Groups REST APIs hosted at

    webexapis.com/v1. Authentication uses OAuth 2.0 access tokens issued

    by the Webex developer hub.

    '
  version: 1.0.0
  contact:
    name: Cisco DevNet
    url: https://developer.cisco.com/docs/directory-connectors/
servers:
- url: https://webexapis.com/v1
security:
- bearerAuth: []
tags:
- name: Groups
paths:
  /groups:
    get:
      tags:
      - Groups
      summary: List groups
      operationId: listGroups
      parameters:
      - in: query
        name: orgId
        schema:
          type: string
      - in: query
        name: includeMembers
        schema:
          type: boolean
      - in: query
        name: max
        schema:
          type: integer
      responses:
        '200':
          description: A list of groups
    post:
      tags:
      - Groups
      summary: Create a group
      operationId: createGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        '200':
          description: Created group
  /groups/{groupId}:
    parameters:
    - in: path
      name: groupId
      required: true
      schema:
        type: string
    get:
      tags:
      - Groups
      summary: Get a group
      operationId: getGroup
      responses:
        '200':
          description: A group
    patch:
      tags:
      - Groups
      summary: Update a group
      operationId: updateGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
      responses:
        '200':
          description: Updated group
    delete:
      tags:
      - Groups
      summary: Delete a group
      operationId: deleteGroup
      responses:
        '204':
          description: Deleted
components:
  schemas:
    Group:
      type: object
      properties:
        id:
          type: string
        orgId:
          type: string
        displayName:
          type: string
        description:
          type: string
        memberSize:
          type: integer
        members:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
              display:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2-Access-Token