openapi: 3.1.2
info:
  description: "You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current\ndevelopment version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).\n\n## Introduction\n\nThe documentation for the APIv3 is written according to the [OpenAPI 3.1 Specification](https://swagger.io/specification/).\nYou can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)\nor the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),\nin your OpenProject installation under `/api/docs`.\nIn the latter you can try out the various API endpoints directly interacting with our OpenProject data.\nMoreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`\n(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).\n\nThe APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).\nThis means that each endpoint of this API will have links to other resources or actions defined in the resulting body.\n\nThese related resources and actions for any given resource will be context sensitive. For example, only actions that the\nauthenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any\ngiven response.\n\nAs an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only\nbe present when the user you authenticated has been granted a permission to update the work package in the assigned project.\n\n## HAL+JSON\n\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\nRead more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n\n**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:\n\n- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)\n- `_links` - contains all related resource and action links available for the resource\n- `_embedded` - contains all embedded objects\n\nHAL does not guarantee that embedded resources are embedded in their full representation, they might as well be\npartially represented (e.g. some properties can be left out).\nHowever in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.\n\n## API response structure\n\nAll API responses contain a single HAL+JSON object, even collections of objects are technically represented by\na single HAL+JSON object that itself contains its members. More details on collections can be found\nin the [Collections Section](https://www.openproject.org/docs/api/collections/).\n\n## Authentication\n\nThe API supports the following authentication schemes:\n\n* Session-based authentication\n* API tokens\n    * passed as Bearer token\n    * passed via Basic auth\n* OAuth 2.0\n    * using built-in authorization server\n    * using an external authorization server (RFC 9068)\n\nDepending on the settings of the OpenProject instance many resources can be accessed without being authenticated.\nIn case the instance requires authentication on all requests the client will receive an **HTTP 401** status code\nin response to any request.\n\nOtherwise unauthenticated clients have all the permissions of the anonymous user.\n\n### Session-based authentication\n\nThis means you have to login to OpenProject via the Web-Interface to be authenticated in the API.\nThis method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.\n\nIn this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.\n\n### API token as bearer token\n\nUsers can authenticate towards the API v3 using an API token as a bearer token.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -H \"Authorization: Bearer $API_KEY\" https://community.openproject.org/api/v3/users/42\n```\n\nUsers can generate API tokens on their account page.\n\n### API token through Basic Auth\n\nAPI tokens can also be used with basic auth, using the user name `apikey` (NOT your login) and the API token as the password.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42\n```\n\n### OAuth 2.0 authentication\n\nOpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.\n\nTo get started, you first need to register an application in the OpenProject OAuth administration section of your installation.\nThis will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).\n\nYou can then use one the following guides to perform the supported OAuth 2.0 flows:\n\n- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)\n\n- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential\n\n- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access\n\n### OAuth 2.0 using an external authorization server\n\nThere is a possibility to use JSON Web Tokens (JWT) generated by an OIDC provider configured in OpenProject as a bearer token to do authenticated requests against the API.\nThe following requirements must be met:\n\n- OIDC provider must be configured in OpenProject with **jwks_uri**\n- JWT must be signed using RSA algorithm\n- JWT **iss** claim must be equal to OIDC provider **issuer**\n- JWT **aud** claim must contain the OpenProject **client ID** used at the OIDC provider\n- JWT **scope** claim must include a valid scope to access the desired API (e.g. `api_v3` for APIv3)\n- JWT must be actual (neither expired or too early to be used)\n- JWT must be passed in Authorization header like: `Authorization: Bearer {jwt}`\n- User from **sub** claim must be linked to OpenProject before (e.g. by logging in), otherwise it will be not authenticated\n\nIn more general terms, OpenProject should be compliant to [RFC 9068](https://www.rfc-editor.org/rfc/rfc9068) when validating access tokens.\n\n### Why not username and password?\n\nThe simplest way to do basic auth would be to use a user's username and password naturally.\nHowever, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.\n\nUsing **username and password** directly would have some advantages:\n\n* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.\n\n* No extra logic for token management necessary.\n\nOn the other hand using **API keys** has some advantages too, which is why we went for that:\n\n* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.\n\n* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.\n\nMost importantly users may not actually have a password to begin with. Specifically when they have registered\nthrough an OpenID Connect provider.\n\n## Cross-Origin Resource Sharing (CORS)\n\nBy default, the OpenProject API is _not_ responding with any CORS headers.\nIf you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.\n\nPlease see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on\nhow to selectively enable CORS.\n\n## Allowed HTTP methods\n\n- `GET` - Get a single resource or collection of resources\n\n- `POST` - Create a new resource or perform\n\n- `PATCH` - Update a resource\n\n- `DELETE` - Delete a resource\n\n## Compression\n\nResponses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)\nare supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).\nIf no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed."
  title: OpenProject API V3 (Stable) Actions & Capabilities Groups API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:
- description: 'Groups are collections of users. They support assigning/unassigning multiple users to/from a project in one operation.


    This resource does not yet have the form and schema endpoints. But as all properties are static, clients should still be able

    to work with this resource.


    ## Actions


    ## Actions


    | Link                | Description                                                          | Condition                                                        |

    |:-------------------:| -------------------------------------------------------------------- | ---------------------------------------------------------------- |

    | delete              | Deletes the group.                                                   | **Permission**: Administrator                                    |

    | updateImmediately   | Updates the group''s attributes.                                      | **Permission**: Administrator                                    |


    ## Linked Properties


    |  Link              | Description                                                                                                                                                           | Type              | Constraints           | Supported operations | Condition                                                                |

    |:-----------:       |--------------------------------------------------------------                                                                                                         | -------------     | --------------------- | -------------------- | -----------------------------------------                                |

    | self               | This group                                                                                                                                                            | Group             | not null              | READ                 |                                                                          |

    | memberships        | Link to collection of all the group''s memberships. The list will only include the memberships in projects in which the requesting user has the necessary permissions. | MemberCollection  |                       | READ                 | **Permission**: view members or manage members in any project            |

    | members            | The list all all the users that are members of the group                                                                                                              | UserCollection    |                       | READ/WRITE           | **Permission**: manage members in any project to read & admin to write   |


    Depending on custom fields defined for versions, additional linked properties might exist.


    ## Local Properties


    | Property     | Description                                                | Type     | Constraints                                          | Supported operations | Condition                                                      |

    | :----------: | ---------------------------------------------------------  | -------- | ---------------------------------------------------- | -------------------- | -----------------------------------------------------------    |

    | id           | Group''s id                                                 | Integer  | x > 0                                                | READ                 |                                                                |

    | name         | Group''s full name, formatting depends on instance settings | String   |                                                      | READ/WRITE           | Admin to write                                                 |

    | createdAt    | Time of creation                                           | DateTime |                                                      | READ                 | Only visible by admins                                         |

    | updatedAt    | Time of the most recent change to the user                 | DateTime |                                                      | READ                 | Only visible by admins                                         |


    Depending on custom fields defined for versions, additional properties might exist.'
  name: Groups
paths:
  /api/v3/groups:
    get:
      summary: List groups
      operationId: list_groups
      tags:
      - Groups
      description: 'Returns a collection of groups. The client can choose to filter the

        groups similar to how work packages are filtered. In addition to the provided

        filters, the server will reduce the result set to only contain groups, for which

        the requesting client has sufficient permissions (*view_members*, *manage_members*).'
      parameters:
      - name: sortBy
        description: 'JSON specifying sort criteria.

          Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:


          + id: Sort by primary key


          + created_at: Sort by group creation datetime


          + updated_at: Sort by the time the group was updated last'
        in: query
        required: false
        example: '[["id", "asc"]]'
        schema:
          default: '[["id", "asc"]]'
          type: string
      - name: select
        description: Comma separated list of properties to include.
        in: query
        required: false
        example: total,elements/name,elements/self,self
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/GroupCollectionModel'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** View members or manage members in any project'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
    post:
      summary: Create group
      operationId: create_group
      tags:
      - Groups
      description: Creates a new group applying the attributes provided in the body.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupWriteModel'
      responses:
        '201':
          description: Created
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** Administrator'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          description: 'Returned if:


            * a constraint for a property was violated (`PropertyConstraintViolation`)'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _embedded:
                  details:
                    attribute: name
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                message: Name can't be blank.
  /api/v3/groups/{id}:
    delete:
      summary: Delete group
      operationId: delete_group
      tags:
      - Groups
      description: Deletes the group.
      parameters:
      - name: id
        description: Group id
        example: 1
        in: path
        required: true
        schema:
          type: integer
      responses:
        '202':
          description: 'Returned if the group was marked for deletion.


            Note that the response body is empty as of now. In future versions of the API a body

            *might* be returned, indicating the progress of deletion.'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** Administrator'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
        '404':
          description: 'Returned if the group does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** Administrator


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
    get:
      summary: Get group
      operationId: get_group
      tags:
      - Groups
      description: Fetches a group resource.
      parameters:
      - name: id
        description: Group id
        example: 1
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/GroupModel'
              examples:
                group response:
                  $ref: '#/components/examples/GroupResponse'
        '404':
          description: 'Returned if the group does not exist or if the API user does not have permission to view them.


            **Required permission** If the user has the *manage members* permission in at least one project the user will be able to query all groups. If not, the user

            will be able to query all groups which are members in projects, he has the *view members* permission in.'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                message: The requested resource could not be found.
    patch:
      summary: Update group
      operationId: update_group
      tags:
      - Groups
      description: 'Updates the given group by applying the attributes provided in the body.


        Please note that the `members` array provided will override the existing set of members (similar to a PUT). A

        client thus has to provide the complete list of members the group is to have after the PATCH even if only one

        member is to be added.'
      parameters:
      - name: id
        description: Group id
        example: 1
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupWriteModel'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/GroupModel'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** Administrator'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
        '404':
          description: 'Returned if the group does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission** If the user has the *manage members* permission in at least one project the user will be able to query all groups. If not, the user

            will be able to query all groups which are members in projects, he has the *view members* permission in.


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                message: The requested resource could not be found.
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          description: 'Returned if:


            * a constraint for a property was violated (`PropertyConstraintViolation`)'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _embedded:
                  details:
                    attribute: members
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                message: Member is already taken.
components:
  schemas:
    CollectionModel:
      type: object
      required:
      - _type
      - total
      - count
      - _links
      properties:
        _type:
          type: string
          enum:
          - Collection
        total:
          type: integer
          description: The total amount of elements available in the collection.
          minimum: 0
        count:
          type: integer
          description: Actual amount of elements in this response.
          minimum: 0
        _links:
          $ref: '#/components/schemas/CollectionLinks'
    CollectionLinks:
      type: object
      required:
      - self
      properties:
        self:
          allOf:
          - $ref: '#/components/schemas/Link'
          - description: 'This collection resource.


              **Resource**: Collection'
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    UserModel:
      allOf:
      - $ref: '#/components/schemas/PrincipalModel'
      - $ref: '#/components/schemas/CustomFieldProperties'
      - type: object
        required:
        - _type
        - avatar
        properties:
          _type:
            type: string
            enum:
            - User
          avatar:
            type:
            - string
            - 'null'
            format: uri
            description: URL to user's avatar
          login:
            type: string
            description: 'The user''s login name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 256
          firstName:
            type: string
            description: 'The user''s first name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 30
          lastName:
            type: string
            description: 'The user''s last name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 30
          email:
            type: string
            description: 'The user''s email address


              # Conditions


              - E-Mail address not hidden

              - User is not a new record

              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 60
          admin:
            type: boolean
            description: 'Flag indicating whether or not the user is an admin


              # Conditions


              - `admin`'
          status:
            type: string
            description: 'The current activation status of the user.


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
          language:
            type: string
            description: 'User''s language | ISO 639-1 format


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
          identityUrl:
            type:
            - string
            - 'null'
            description: 'User''s identity_url for OmniAuth authentication.

              **Deprecated:** It will be removed in the near future.


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            deprecated: true
          createdAt:
            type: string
            format: date-time
            description: Time of creation
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the user
          _links:
            type: object
            properties:
              showUser:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A relative path to show the user in the web application.


                    # Condition


                    - User is not a new record

                    - User is not `locked`'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A link to update the user resource.


                    # Conditions


                    - `admin`'
              lock:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Restrict the user from logging in and performing any actions.


                    # Conditions


                    - User is not locked

                    - `admin`'
              unlock:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Allow a locked user to login and act again.


                    # Conditions


                    - User is not locked

                    - `admin`'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n  - `admin`\n  - Setting `users_deletable_by_admin` is set\nor:\n  - User is self\n  - Setting `users_deletable_by_self` is set"
              authSource:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Permanently remove a user from the instance


                    # Conditions


                    - LDAP authentication configured

                    - `admin`'
    GroupWriteModel:
      type: object
      properties:
        name:
          type: string
          description: The new group name.
        _links:
          type: object
          properties:
            members:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A new member for the group.


                    **Resource**: User'
      example:
        name: Emperor's guard
        _links:
          members:
          - href: /api/v3/users/42
          - href: /api/v3/users/43
          - href: /api/v3/users/44
    GroupModel:
      allOf:
      - $ref: '#/components/schemas/PrincipalModel'
      - $ref: '#/components/schemas/CustomFieldProperties'
      - type: object
        required:
        - _type
        - _embedded
        properties:
          _type:
            type: string
            enum:
            - Group
          _embedded:
            type: object
            properties:
              members:
                type: array
                description: Embedded list of members.
                items:
                  $ref: '#/components/schemas/UserModel'
          _links:
            type: object
            properties:
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This group resource


                    **Resource**: Group'
              members:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A member of the group


                      # Conditions:


                      - user has permission `manage_members` in any project


                      **Resource**: User'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An collection of all memberships of the group.


                    **Resource**: MembershipCollection'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An href to delete the group.


                    # Conditions:


                    - `admin`'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An href to update the group.


                    # Conditions:


                    - `admin`


                    **Resource**: Group'
    GroupCollectionModel:
      allOf:
      - $ref: '#/components/schemas/CollectionModel'
      - type: object
        required:
        - _links
        - _embedded
        properties:
          _links:
            type: object
            required:
            - self
            properties:
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This group collection


                    **Resource**: Collection'
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  $ref: '#/components/schemas/GroupModel'
      example:
        _type: Collection
        total: 2
        count: 2
        _links:
          self:
            href: /api/v3/groups
        _embedded:
          elements:
          - _type: Group
            id: 1337
            name: Stormtroopers
            createdAt: '2022-09-23T11:06:36.300Z'
            updatedAt: '2022-09-23T11:06:36.300Z'
            _links:
              self:
                href: /api/v3/groups/9
                title: Stormtroopers
              delete:
                href: /api/v3/group/9
                method: delete
              memberships:
                href: /api/v3/memberships?filters=[{"principal":{"operator":"=","values":["9"]}}]
                title: Memberships
              updateImmediately:
                href: /api/v3/group/9
                method: patch
              members:
              - href: /api/v3/users/363
                title: ST-097E
              - href: /api/v3/users/60
                title: ST-C-334
          - _abbreviated: Group resource shortened for brevity
            id: 1338
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    PrincipalModel:
      type: object
      required:
      - _type
      - id
      - name
      - _links
      properties:
        _type:
          type: string
          enum:
          - User
          - Group
          - PlaceholderUser
        id:
          type: integer
          description: The principal's unique identifier.
          minimum: 1
        name:
          type: string
          description: The principal's display name, layout depends on instance settings.
        createdAt:
          type: string
          format: date-time
          description: Time of creation
        updatedAt:
          type: string
          format: date-time
          description: Time of the most recent change to the principal
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This principal resource.


                  **Resource**: User|Group|PlaceholderUser'
            memberships:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'An href to the collection of the principal''s memberships.


                  # Conditions:


                  - user has permission `view_members` or `manage_members` in any project


                  **Resource**: Collection'
    CustomFieldProperties:
      type: object
      patternProperties:
        ^customField\d+$:
          type:
          - 'null'
          - number
          - boolean
          - string
          - object
          description: 'A custom field value, that belongs to a custom field of a simple type:


            - Boolean

            - Date

            - Float

            - Integer

            - Link (URL)

            - Text

            - Long text'
  examples:
    GroupResponse:
      value:
        _type: Group
        id: 26
        name: Force Users
        createdAt: '2024-01-11T15:54:16.542Z'
        updatedAt: '2024-01-11T15:58:02.237Z'
        _embedded:
          members:
          - _type: User
            id: 23
            name: Grogu Jarin
            _abbreviated: Principal resource shortened for brevity
          - _type: User
            id: 14
            name: Mara Jade
            _abbreviated: Principal resource shortened for brevity
          - _type: User
            id: 3
            name: Darth Vader
            _abbreviated: Principal resource shortened for brevity
        _links:
          self:
            href: /api/v3/groups/26
            title: Force Users
          memberships:
            href: /api/v3/memberships?filters=%5B%7B%22principal%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%2226%22%5D%7D%7D%5D
            title: Memberships
          delete:
            href: /api/v3/groups/26
            method: delete
          updateImmediately:
            href: /api/v3/groups/26
            method: patch
          members:
          - href: /api/v3/users/23
            title: Grogu Jarin
          - href: /api/v3/users/14
            title: Mara Jade
          - href: /api/v3/users/3
            title: Darth Vader
  responses:
    MissingContentType:
      description: Occurs when the client did not send a Content-Type header
      content:
        text/plain:
          schema:
            type: string
          example: Missing content-type header
    InvalidRequestBody:
      description: Occurs when the client did not send a valid JSON object in the request body.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
            message: The request body was not a single JSON object.
    UnsupportedMediaType:
      description: Occurs when the client sends an unsupported Content-Type header.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:TypeNotSupported
            message: Expected CONTENT-TYPE to be (expected value) but got (actual value).
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic