Internet2 Co Groups.json API

openapi: 3.2.0
info:
  title: COmanage Registry REST API v1 Co Groups.json API
  description: A collection of lower level APIs providing table level access to the COmanage Registry Data Model.
  contact:
    name: COmanage Project
    url: https://spaces.at.internet2.edu/display/COmanage/About+the+COmanage+Project
    email: comanage-users@internet2.edu
  license:
    name: APACHE LICENSE, VERSION 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 0.4.0
servers:
- url: https://localhost/registry
  description: 'Most deployments serve Registry using the default path /registry. If your deployment changes the

    default path you must adjust the relative URIs.

    '
security:
- basicAuth: []
tags:
- name: Co Groups.json
paths:
  /co_groups.json:
    get:
      summary: Retrieve existing groups for CO or person by ID or identifier
      description: 'Retrieve existing `CoGroup` objects for the CO with ID `coid`,

        or for the CO Person with ID `copersonid`, or for the CO Person

        with identifier `identifier`.


        With no query string parameter retrieve all existing CoGroups

        (requires platform administrator privileges).'
      operationId: getCoGroups
      tags:
      - Co Groups.json
      parameters:
      - name: coid
        in: query
        schema:
          type: integer
        description: 'Retrieve `CoGroup` objects attached to the CO with ID `coid`.

          '
        examples:
          coid-example:
            value: /co_groups.json?coid=2
            summary: Retrieve CoGroups objects for the CO with ID 2
      - name: copersonid
        in: query
        schema:
          type: integer
        description: 'Retrieve `CoGroup` objects attached to the CO Person with ID `copersonid`.

          '
        examples:
          copersonid-example:
            value: /co_groups.json?copersonid=1000
            summary: Retrieve CoGroups objects attached to the CO Person with ID 1000
      - name: search.identifier
        in: query
        schema:
          type: string
        description: 'Retrieve `CoGroup` objects attached to the CO Person with identifier `identifier`.

          Requires the `coid` query parameter.

          '
        examples:
          search.identifier-example:
            value: /co_groups.json?coid=2&search.identifier=albert.einstein
            summary: Retrieve CoGroups objects attached to the CO Person in CO 2 with identifier albert.einstein
      responses:
        '200':
          description: CoGroups returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoGroupsResponseType'
        '401':
          description: Authentication required.
        '404':
          description: coid not found.
        '500':
          description: Unknown error.
    post:
      summary: Add a new group
      description: Add a new `CoGroup` object.
      operationId: addCoGroup
      tags:
      - Co Groups.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoGroupsRequestType'
      responses:
        '201':
          description: CoGroup added
          content:
            application/json:
              schema:
                type: object
                properties:
                  ResponseType:
                    type: string
                    enum:
                    - NewObject
                  Version:
                    type: string
                    enum:
                    - '1.0'
                  ObjectType:
                    type: string
                    enum:
                    - CoGroup
                  Id:
                    type: string
                    example: '3'
        '400':
          description: CoGroup Request not provided in POST body.
        '401':
          description: Authentication required.
        '403':
          description: Name In Use or Name Reserved.
        '500':
          description: Unknown error.
components:
  schemas:
    CoGroupResponse:
      type: object
      required:
      - Version
      - Id
      - CoId
      - Name
      - Description
      - Open
      - Status
      - GroupType
      - Auto
      - Created
      - Modified
      - Revision
      - Deleted
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        Id:
          type: string
          example: '40'
        CoId:
          type: string
          example: '2'
        CouId:
          type: string
          example: '2'
        Name:
          type: string
          example: Data Readers
        Description:
          type: string
          example: People with read access to the data
        Open:
          type: boolean
          example: false
        Status:
          type: string
          enum:
          - Active
          - Suspended
          example: Active
        GroupType:
          type: string
          enum:
          - S
          - MA
          - A
          - M
          - AP
          - AN
          - MN
        Auto:
          type: boolean
          example: false
        NestingModeAll:
          type: boolean
          example: false
        Created:
          type: string
          example: 2022-02-28 18:39:43
        Modified:
          type: string
          example: 2022-02-28 18:39:43
        Revision:
          type: string
          example: '0'
        Deleted:
          type: boolean
          example: false
        Actoridentifier:
          type: string
          example: albert.einstein
    CoGroupRequest:
      type: object
      required:
      - Version
      - CoId
      - Name
      - Description
      - Open
      - Status
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        CoId:
          type: string
          example: '2'
        Name:
          type: string
          example: Data Readers
        Description:
          type: string
          example: People with read access to the data
        Open:
          type: boolean
          example: true
        Status:
          type: string
          enum:
          - Active
          - Suspended
          example: Active
        CouId:
          type: string
          example: '7'
    CoGroupsRequestType:
      type: object
      properties:
        RequestType:
          type: string
          enum:
          - CoGroups
        Version:
          type: string
          enum:
          - '1.0'
        CoGroups:
          type: array
          items:
            $ref: '#/components/schemas/CoGroupRequest'
    CoGroupsResponseType:
      type: object
      properties:
        ResponseType:
          type: string
          enum:
          - CoGroups
        Version:
          type: string
          enum:
          - '1.0'
        CoGroups:
          type: array
          items:
            $ref: '#/components/schemas/CoGroupResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: COmanage Registry REST API v1
  url: https://spaces.at.internet2.edu/display/COmanage/REST+API+v1