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-group-members-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 Group Members 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 Group Members
paths:
  /co_group_members/{id}.json:
    delete:
      summary: Remove a member from a group
      description: 'Remove a member from a CoGroup by deleting the `CoGroupMember` object

        with ID `id`.'
      operationId: deleteCoGroupMember
      tags:
      - Co Group Members
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Remove the `CoGroupMember` object with ID `id`.

          '
        examples:
          id-example:
            value: /co_group_members/10.json
            summary: Remove CoGroupMember object with ID 10
      responses:
        '200':
          description: CoGroupMember deleted.
        '400':
          description: ID `id` not provided.
        '401':
          description: Authentication required.
        '404':
          description: ID `id` not found for object.
        '500':
          description: Unknown error.
    get:
      summary: Retrieve an existing group membership
      description: Retrieve an existing CoGroupMember object with ID `id`.
      operationId: getCoGroupMember
      tags:
      - Co Group Members
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
        description: 'Retrieve the `CoGroupMember` object with ID `id`.

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

          '
        examples:
          id-example:
            value: /co_group_members/10.json
            summary: Edit CoGroupMember object with ID 10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoGroupMembersRequestType'
      responses:
        '200':
          description: CoGroupMember updated.
        '400':
          description: CoGroupMember Request not provided in body or error in one or more fields.
        '401':
          description: Authentication required.
        '403':
          description: The specififed CoGroup or CoPerson does not exist, or the CoPerson is already a member of the CoGroup.
        '404':
          description: id not found for object.
        '500':
          description: Unknown error.
components:
  schemas:
    CoGroupMemberRequest:
      type: object
      required:
      - Version
      - CoGroupId
      - Person
      - Member
      - Owner
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        CoGroupId:
          type: string
          example: '20'
        Person:
          type: object
          properties:
            Type:
              type: string
              enum:
              - CO
              example: CO
            Id:
              type: string
              example: '12'
        Member:
          type: boolean
          example: true
        Owner:
          type: boolean
          example: false
        ValidFrom:
          type: string
          example: '2024-03-22 05:00:00'
        ValidThrough:
          type: string
          example: '2024-04-01 04:59:59'
    CoGroupMembersResponseType:
      type: object
      properties:
        ResponseType:
          type: string
          enum:
          - CoGroupMembers
        Version:
          type: string
          enum:
          - '1.0'
        CoGroupMembers:
          type: array
          items:
            $ref: '#/components/schemas/CoGroupMemberResponse'
    CoGroupMemberResponse:
      type: object
      required:
      - Version
      - Id
      - CoGroupId
      - Person
      - Member
      - Owner
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        Id:
          type: string
          example: '279'
        CoGroupId:
          type: string
          example: '40'
        Person:
          type: object
          properties:
            Type:
              type: string
              enum:
              - CO
              example: CO
            Id:
              type: string
              example: '421'
        Member:
          type: boolean
          example: true
        Owner:
          type: boolean
          example: true
        ValidFrom:
          type: string
          example: '2024-03-22 05:00:00'
        ValidThrough:
          type: string
          example: '2024-04-01 04:59:59'
    CoGroupMembersRequestType:
      type: object
      properties:
        RequestType:
          type: string
          enum:
          - CoGroupMembers
        Version:
          type: string
          enum:
          - '1.0'
        CoGroupMembers:
          type: array
          items:
            $ref: '#/components/schemas/CoGroupMemberRequest'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: COmanage Registry REST API v1
  url: https://spaces.at.internet2.edu/display/COmanage/REST+API+v1