Utrecht University

Utrecht University groups API

The groups API from Utrecht University — 15 operation(s) for groups.

GitHub OpenAPI

Operations 15

POST /group_get_user_role Get role of user in group.
POST /group_data Retrieve group data as hierarchy for user.
POST /group_process_csv Process contents of CSV file containing group definitions.
POST /group_categories Retrieve category list.
POST /group_subcategories Retrieve subcategory list.
POST /group_search_users
POST /group_exists Check if group exists.
POST /group_create Create a new group.
POST /group_update Update group property.
POST /group_delete Delete a group.
POST /group_get_description Retrieve description of a group.
POST /group_user_is_member Check if user is member of a group.
POST /group_user_add Add a user to a group.
POST /group_user_update_role Update role of a user in a group.
POST /group_remove_user_from_group Remove a user from a group.

Documentation

📖
Documentation
https://utrechtuniversity.github.io/yoda/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/openapi/utrecht-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/json-schema/utrecht-yoda-result-schema.json

Other Resources

🔗
GitHub
https://github.com/UtrechtUniversity/yoda
🔗
SourceCode
https://github.com/UtrechtUniversity/yoda-ruleset
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/vocabulary/utrecht-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/json-ld/utrecht-context.jsonld
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/rules/utrecht-rules.yml
🔗
x-conformance
https://raw.githubusercontent.com/api-evangelist/utrecht/refs/heads/main/conformance/utrecht-domain-standards.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/utrecht-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

utrecht-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
x-method: searched
x-source-url: https://github.com/UtrechtUniversity/yoda-ruleset/blob/development/tools/api/generate-openapi.py
x-provenance: >-
  Utrecht University's own document. The Yoda OpenAPI is emitted by
  tools/api/generate-openapi.py in github.com/UtrechtUniversity/yoda-ruleset
  ('Copyright (c) 2020-2026, Utrecht University', GPLv3), which walks the ruleset's own
  function signatures and docstrings; --core yields 'Yoda core API' and --module <m> yields
  'Yoda <m> API'. Fetched and then split per tag by refine-openapis; the pristine sources are
  in openapi/_original/. Re-based off the upstream placeholder host portal.yoda.test onto the
  verified production host portal.yoda.uu.nl on 2026-08-30, and the refine title weld
  ('Yoda core admin <X> API' on 19 non-admin outputs) repaired at the same time.
x-generated: '2026-08-30'
info:
  description: >-
    Yoda core ruleset containing iRODS and Python rules and policies useful for all Yoda environments. Yoda is developed and operated by Utrecht University.
  contact:
    email: l.r.westerhof@uu.nl
  version: 2.1.0
  title: Yoda core Groups API
servers:
- url: https://portal.yoda.uu.nl/api
  description: Utrecht University production Yoda portal (verified live 2026-08-30; API requires an
    authenticated session or a Yoda data access token)
- url: https://i-lab.yoda.uu.nl/api
  description: Utrecht University i-Lab Yoda portal (verified live 2026-08-30)
x-operator: institution
x-placeholder-removed: >-
  The upstream Yoda repository ships servers[] as https://portal.yoda.test/api,
  'Local Yoda development server'. .test is an RFC 2606 reserved TLD and is never a
  surface, so it is dropped from servers[] rather than carried as an unattributable
  host. It is recorded here so a later run does not read its absence as data loss.
x-operator-evidence: >-
  Yoda is authored by Utrecht University (github.com/UtrechtUniversity/yoda-ruleset, GPL-3.0,
  "Copyright (c) Utrecht University") and Utrecht runs its own production instance at
  portal.yoda.uu.nl. info.contact is l.r.westerhof@uu.nl, a uu.nl address. This is the
  institution's own engineering, not a vendor contract running under its name.
security:
- cookieAuth: []
- basicAuth: []
tags:
- name: groups
paths:
  /group_get_user_role:
    post:
      tags:
      - groups
      summary: 'Get role of user in group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - group_name
              properties:
                username:
                  type: string
                  description: User to return type of
                  default: null
                group_name:
                  type: string
                  description: Group name of user
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_data:
    post:
      tags:
      - groups
      summary: 'Retrieve group data as hierarchy for user.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_process_csv:
    post:
      tags:
      - groups
      summary: 'Process contents of CSV file containing group definitions.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - csv_header_and_data
              - allow_update
              - delete_users
              properties:
                csv_header_and_data:
                  type: string
                  description: CSV data holding a head conform description and the actual row data
                  default: null
                allow_update:
                  type: boolean
                  description: Allow updates in groups
                  default: null
                delete_users:
                  type: boolean
                  description: Allow for deleting of users from groups
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_categories:
    post:
      tags:
      - groups
      summary: Retrieve category list.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_subcategories:
    post:
      tags:
      - groups
      summary: 'Retrieve subcategory list.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - category
              properties:
                category:
                  type: string
                  description: Category to retrieve subcategories of
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_search_users:
    post:
      tags:
      - groups
      summary: ''
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - pattern
              properties:
                pattern:
                  type: string
                  description: (undocumented)
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_exists:
    post:
      tags:
      - groups
      summary: 'Check if group exists.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - group_name
              properties:
                group_name:
                  type: string
                  description: Name of the group to check for existence
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_create:
    post:
      tags:
      - groups
      summary: 'Create a new group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - group_name
              - category
              - subcategory
              - schema_id
              - expiration_date
              - description
              - data_classification
              - sram_co
              properties:
                group_name:
                  type: string
                  description: Name of the group to create
                  default: null
                category:
                  type: string
                  description: Category of the group to create
                  default: null
                subcategory:
                  type: string
                  description: Subcategory of the group to create
                  default: null
                schema_id:
                  type: string
                  description: Schema-id for the group to be created
                  default: null
                expiration_date:
                  type: string
                  description: Retention period for the group
                  default: null
                description:
                  type: string
                  description: Description of the group to create
                  default: null
                data_classification:
                  type: string
                  description: Data classification of the group to create
                  default: null
                sram_co:
                  type: boolean
                  description: If True, create a SRAM CO
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_update:
    post:
      tags:
      - groups
      summary: 'Update group property.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - group_name
              - property_name
              - property_value
              properties:
                group_name:
                  type: string
                  description: Name of the group to update property of
                  default: null
                property_name:
                  type: string
                  description: Name of the property to update
                  default: null
                property_value:
                  type: string
                  description: Value of the property to update
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_delete:
    post:
      tags:
      - groups
      summary: 'Delete a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - group_name
              properties:
                group_name:
                  type: string
                  description: Name of the group to delete
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_get_description:
    post:
      tags:
      - groups
      summary: 'Retrieve description of a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - group_name
              properties:
                group_name:
                  type: string
                  description: Name of the group
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_user_is_member:
    post:
      tags:
      - groups
      summary: 'Check if user is member of a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - group_name
              properties:
                username:
                  type: string
                  description: Name of the user
                  default: null
                group_name:
                  type: string
                  description: Name of the group
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_user_add:
    post:
      tags:
      - groups
      summary: 'Add a user to a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - group_name
              properties:
                username:
                  type: string
                  description: Name of the user
                  default: null
                group_name:
                  type: string
                  description: Name of the group
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_user_update_role:
    post:
      tags:
      - groups
      summary: 'Update role of a user in a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - group_name
              - new_role
              properties:
                username:
                  type: string
                  description: Name of the user
                  default: null
                group_name:
                  type: string
                  description: Name of the group
                  default: null
                new_role:
                  type: string
                  description: New role of the user
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
  /group_remove_user_from_group:
    post:
      tags:
      - groups
      summary: 'Remove a user from a group.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - group_name
              properties:
                username:
                  type: string
                  description: Name of the user
                  default: null
                group_name:
                  type: string
                  description: Name of the group
                  default: null
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  status_info:
                    type:
                    - string
                    - 'null'
                  data: {}
        '400':
          $ref: '#/components/responses/status_400'
        '500':
          $ref: '#/components/responses/status_500'
components:
  schemas:
    result_error:
      type: object
      properties:
        status:
          type: string
          description: Holds an error ID
        status_info:
          type: string
          description: Holds a human-readable error description
        data:
          description: empty
          type:
          - object
          - 'null'
  responses:
    status_500:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/result_error'
    status_400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/result_error'
  securitySchemes:
    cookieAuth:
      in: cookie
      type: apiKey
      name: yoda_session
    basicAuth:
      type: http
      scheme: basic