openapi: 3.2.0
info:
  title: Cesnet Integration Manager API
  version: 0.0.0
  contact:
    url: https://perun-aai.org
    email: perun@cesnet.cz
  description: 'Operations tagged IntegrationManager across 2 of this provider''s published API definitions: cesnet-perun-rpc-openapi.yml, cesnet-perun-rpc-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{server}/{authentication}/rpc
  description: Perun RPC server
  variables:
    server:
      default: api-dev.perun-aai.org
      description: DNS name of a Perun server
    authentication:
      default: ba
      description: 'way of authentication:

        ba - HTTP Basic Auth

        krb - Kerberos

        non - no authentication

        cert - X509 client certificate

        oauth - OAuth 2.0 bearer access token

        fed - SAML federation

        '
      enum:
      - ba
      - krb
      - non
      - cert
      - oauth
      - fed
security:
- BasicAuth: []
- BearerAuth: []
tags:
- name: IntegrationManager
  description: IntegrationManager RPC API in Perun
  externalDocs:
    url: https://perun-aai.org/documentation/technical-documentation/rpc-api/rpc-javadoc-IntegrationManager.html
paths:
  /json/integrationManager/getGroupMemberData:
    get:
      tags:
      - IntegrationManager
      operationId: getGroupMemberData
      summary: Get all member-group relations for all groups with all member-group attributes
      responses:
        '200':
          $ref: '#/components/responses/GroupMemberDataResponse'
        default:
          $ref: '#/components/responses/ExceptionResponse'
    servers:
    - url: https://{server}/{authentication}/rpc
      description: Perun RPC server
      variables:
        server:
          default: api-dev.perun-aai.org
          description: DNS name of a Perun server
        authentication:
          default: ba
          description: 'way of authentication:

            ba - HTTP Basic Auth

            krb - Kerberos

            non - no authentication

            cert - X509 client certificate

            oauth - OAuth 2.0 bearer access token

            fed - SAML federation

            '
          enum:
          - ba
          - krb
          - non
          - cert
          - oauth
          - fed
components:
  schemas:
    AttributeDefinition:
      allOf:
      - $ref: '#/components/schemas/Auditable'
      properties:
        friendlyName:
          type: string
        namespace:
          type: string
        description:
          type:
          - string
          - 'null'
        type:
          type: string
        displayName:
          type: string
        writable:
          type: boolean
        unique:
          type: boolean
        friendlyNameParameter:
          type: string
          readOnly: true
        baseFriendlyName:
          type: string
          readOnly: true
        entity:
          type: string
          readOnly: true
    PerunBean:
      description: identifiable entity in Perun, common ancestor of all entity classes
      type: object
      properties:
        id:
          type: integer
        beanName:
          type: string
      required:
      - id
      - beanName
      discriminator:
        propertyName: beanName
    Auditable:
      description: represents audit information
      allOf:
      - $ref: '#/components/schemas/PerunBean'
      properties:
        createdAt:
          type:
          - string
          - 'null'
        createdBy:
          type:
          - string
          - 'null'
        modifiedAt:
          type:
          - string
          - 'null'
        modifiedBy:
          type:
          - string
          - 'null'
        createdByUid:
          type:
          - integer
          - 'null'
        modifiedByUid:
          type:
          - integer
          - 'null'
    GroupMemberData:
      type: object
      properties:
        relations:
          type: array
          items:
            $ref: '#/components/schemas/GroupMemberRelation'
        groupMemberAttributes:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: array
              items:
                $ref: '#/components/schemas/Attribute'
    GroupMemberRelation:
      type: object
      properties:
        m:
          type: integer
          description: member id
        u:
          type: integer
          description: user_id
        g:
          type: integer
          description: group id
        sg:
          type: integer
          description: source group id
        gn:
          type: string
          description: group_name
        pg:
          type: integer
          description: parent_group_id
        s:
          type: string
          description: source group status
        t:
          type: string
          description: membership type
    PerunException:
      description: exception thrown from inside of Perun
      type: object
      properties:
        errorId:
          type: string
        name:
          type: string
        message:
          type: string
    Attribute:
      allOf:
      - $ref: '#/components/schemas/AttributeDefinition'
      properties:
        valueCreatedAt:
          type:
          - string
          - 'null'
        valueCreatedBy:
          type:
          - string
          - 'null'
        valueModifiedAt:
          type:
          - string
          - 'null'
        valueModifiedBy:
          type:
          - string
          - 'null'
        value: {}
  responses:
    GroupMemberDataResponse:
      description: returns member-groups relations with attributes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GroupMemberData'
    ExceptionResponse:
      description: exception occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PerunException'
  securitySchemes:
    BasicAuth:
      description: HTTP Basic authentication with username and password
      type: http
      scheme: basic
    BearerAuth:
      description: 'OAuth2 Resource Server authentication using access token in ''Authorization: Bearer'' HTTP header'
      type: http
      scheme: bearer
x-refined-from:
- cesnet-perun-rpc-openapi.yml
- cesnet-perun-rpc-openapi.yml