required:
  - created
  - id
  - links
  - newUser
  - recipientEmailAddress
  - role
  - senderId
type: object
properties:
  id:
    type: string
    example: neqek
  senderId:
    type: string
    example: 9gd5l
    description: The ID of the user sending the invitation.
  recipientEmailAddress:
    type: string
    example: tom+docsmember2@wiremock.io
    description: The email address of the user being invited.
  newUser:
    type: boolean
    example: true
    description: Indicates whether the invited user already existed in the system.
  role:
    type: string
    description: The role of the new user within the organisation.
    enum:
      - organisation_admin
      - organisation_member
      - team_admin
      - team_member
      - mock_api_admin
      - mock_api_editor
      - mock_api_user
      - api_template_admin
      - api_template_editor
      - api_template_user
      - api_template_catalogue_admin
      - api_template_catalogue_editor
      - api_template_catalogue_user
      - data_source_admin
      - data_source_editor
      - data_source_user
      - key_admin
      - key_editor
      - key_user
  aclObjectId:
    type: string
    description: The ACL ID of the entity the user is invited to join. If null, the user is not invited to a particular entity, but simply to the organisation.
    example: 8ndxc
    nullable: true
  created:
    type: string
    example: 2024-10-30T19:28:23.802551Z
  links:
    required:
      - self
    type: object
    properties:
      self:
        type: string
        example: /v1/organisations/mgk7g/invitations/neqek