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-people-json-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 People.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 People.json
paths:
  /co_people.json:
    get:
      summary: Retrieve existing people for a CO by email address or identifier
      description: 'Retrieve existing people for the CO with ID `coid`, or existing people in the CO

        with ID `coid` with email address `search.mail`, or existing people in the CO

        with ID `coid` with identifier `search.identifier`.


        Only one of `search.mail` or `search.identifier` may be used in a query.


        The `coid` parameter is required when using `search.mail` or `search.identifier`.


        With no query string parameter retrieve all existing people

        across all COs (requires platform administrator privileges).'
      operationId: getCoPeople
      tags:
      - Co People.json
      parameters:
      - name: coid
        in: query
        schema:
          type: integer
        description: 'Retrieve `CoPerson` objects in the CO with ID `coid`.

          '
        examples:
          coid-example:
            value: /co_people.json?coid=2
            summary: Retrieve CoPerson objects for the CO with ID 2
      - name: search.mail
        in: query
        schema:
          type: string
        description: 'Retrieve `CoPerson` objects in the CO with ID `coid` and with email address `search.mail`.

          '
        examples:
          search.mail-example:
            value: /co_people.json?coid=2&search.mail=albert.einstein@ligo.org
            summary: Retrieve CoPerson objects for the CO with ID 2 and email address albert.einstein@ligo.org
      - name: search.identifier
        in: query
        schema:
          type: string
        description: 'Retrieve `CoPerson` objects in the CO with ID `coid` and with identifier `search.identifier`.

          '
        examples:
          search.identifier-example:
            value: /co_people.json?coid=2&search.identifier=http%3A%2F%2Fcilogon.org%2FserverT%2Fusers%2F64703
            summary: Retrieve CoPerson objects for the CO with ID 2 and identifier http://cilogon.org/serverT/users/64703
      responses:
        '200':
          description: CoPeople returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoPeopleResponseType'
        '401':
          description: Authentication required.
        '404':
          description: id or coid not found.
        '500':
          description: Unknown error.
    post:
      summary: Add a new person
      description: 'Add a new CO Person. A person must have an OrgIdentity before they can be added

        to a CO. Note that linking to an OrgIdentity and invitations are separate operations.'
      operationId: addCoPerson
      tags:
      - Co People.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CoPeopleRequestType'
      responses:
        '201':
          description: CoPerson created
          content:
            application/json:
              schema:
                type: object
                properties:
                  ResponseType:
                    type: string
                    enum:
                    - NewObject
                  Version:
                    type: string
                    enum:
                    - '1.0'
                  ObjectType:
                    type: string
                    enum:
                    - CoPerson
                  Id:
                    type: string
                    example: '100'
        '400':
          description: CoPerson Request not provided in POST body or an error in one or more provided fields.
        '401':
          description: Authentication required.
        '403':
          description: The specififed CO does not exist.
        '500':
          description: Unknown error.
components:
  schemas:
    CoPersonResponse:
      type: object
      required:
      - Version
      - Id
      - CoId
      - Status
      - Created
      - Modified
      - Revision
      - Deleted
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        Id:
          type: string
          example: '40'
        CoId:
          type: string
          example: '2'
        Timezone:
          type: string
          example: America/Chicago
        DateOfBirth:
          type: string
          example: '1970-12-25'
        Status:
          type: string
          enum:
          - Active
          - Approved
          - Confirmed
          - Declined
          - Deleted
          - Denied
          - Duplicate
          - Expired
          - GracePeriod
          - Invited
          - Locked
          - Pending
          - PendingApproval
          - PendingConfirmation
          - PendingVetting
          - Suspended
          example: Active
        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
    CoPeopleRequestType:
      type: object
      properties:
        RequestType:
          type: string
          enum:
          - CoPeople
        Version:
          type: string
          enum:
          - '1.0'
        CoPeople:
          type: array
          items:
            $ref: '#/components/schemas/CoPersonRequest'
    CoPersonRequest:
      type: object
      required:
      - Version
      - CoId
      - Status
      properties:
        Version:
          type: string
          enum:
          - '1.0'
        CoId:
          type: string
          example: '2'
        Timezone:
          type: string
          example: America/Chicago
        DateOfBirth:
          type: string
          example: '1970-12-25'
        Status:
          type: string
          enum:
          - Active
          - Approved
          - Confirmed
          - Declined
          - Deleted
          - Denied
          - Duplicate
          - Expired
          - GracePeriod
          - Invited
          - Locked
          - Pending
          - PendingApproval
          - PendingConfirmation
          - PendingVetting
          - Suspended
          example: Active
    CoPeopleResponseType:
      type: object
      properties:
        ResponseType:
          type: string
          enum:
          - CoPeople
        Version:
          type: string
          enum:
          - '1.0'
        CoPeople:
          type: array
          items:
            $ref: '#/components/schemas/CoPersonResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: COmanage Registry REST API v1
  url: https://spaces.at.internet2.edu/display/COmanage/REST+API+v1