find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/internet2:internet2-co-groups-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: COmanage Registry REST API v1 Co Groups 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
paths:
  /co_groups/{id}.json:
    delete:
      summary: Remove a group
      description: Remove the `CoGroup` object with ID `id`.
      operationId: deleteCoGroup
      tags:
      - Co Groups
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Remove the `CoGroup` object with ID `id`.

          '
        examples:
          id-example:
            value: /co_groups/10.json
            summary: Remove CoGroup object with ID 10
      responses:
        '200':
          description: CoGroup deleted.
        '400':
          description: ID `id` not provided.
        '401':
          description: Authentication required.
        '403':
          description: CoGroup cannot be deleted.
        '404':
          description: ID `id` not found for object.
        '500':
          description: Unknown error.
    get:
      summary: Retrieve an existing group
      description: Retrieve a `CoGroup` object by ID.
      operationId: getCoGroup
      tags:
      - Co Groups
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Retrieve the `CoGroup` object with ID `id`.

          '
        examples:
          id-example:
            value: /co_groups/10.json
            summary: Retrieve CoGroup object with ID 10
      responses:
        '200':
          description: CoGroup returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoGroupsResponseType'
        '401':
          description: Authentication required.
        '404':
          description: id not found for object.
        '500':
          description: Unknown error.
    put:
      summary: Edit an existing group
      description: Edit the `CoGroup` object with ID `id`.
      operationId: editCoGroup
      tags:
      - Co Groups
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Edit the `CoGroup` object with ID `id`.

          '
        examples:
          id-example:
            value: /co_groups/10.json
            summary: Edit CoGroup object with ID 10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoGroupsRequestType'
      responses:
        '200':
          description: CoGroup updated
        '400':
          description: CoGroup Request not provided in body or error in one or more fields
        '401':
          description: Authentication required.
        '403':
          description: Name In Use or Name Reserved
        '404':
          description: id not found for object.
        '500':
          description: Unknown error.
  /co_groups/reconcile.json:
    put:
      summary: Reconcile all group memberships
      description: Reconcile all membership groups in the CO with ID `coid`.
      operationId: reconcileAllCoGroupMembers
      tags:
      - Co Groups
      parameters:
      - name: coid
        in: query
        schema:
          type: integer
        description: 'Reconcile all membership groups for the CO with ID `coid`.

          '
        examples:
          coid-example:
            value: /co_groups/reconcile.json?coid=2
            summary: Reconcile all membership groups for the CO with ID 2
      responses:
        '200':
          description: All CoGroup memberships reconciled.
        '401':
          description: Authentication required.
        '403':
          description: The specified CO does not exist.
        '500':
          description: Unknown error.
  /co_groups/reconcile/{id}.json:
    post:
      summary: Reconcile memberships for one group
      description: Reconcile memberships for the CO Group with ID `id`.
      operationId: reconcileCoGroupMembers
      tags:
      - Co Groups
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Reconcile memberships for the CO Group with ID `id`.

          '
        examples:
          id-example:
            value: /co_groups/reconcile/10.json
            summary: Reconcile memberships for the CO Group with ID 10
      responses:
        '200':
          description: All memberships reconciled.
        '401':
          description: Authentication required.
        '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