publiq Users API

openapi: 3.2.0
info:
  title: Publiq Users API
  version: '3.0'
  contact:
    name: publiq helpdesk
    email: technical-support@publiq.be
    url: https://docs.publiq.be
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Users across 2 of this provider''s published API definitions: uitdatabank-entry.json, publiq-uitdatabank-entry-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://io-test.uitdatabank.be
  description: Testing
- url: https://io.uitdatabank.be
  description: Production
tags:
- name: Users
paths:
  /user:
    get:
      summary: current user - get
      operationId: user-get
      description: Returns the details of the current user.
      tags:
      - Users
      responses:
        '200':
          description: The user details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    example: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    format: uuid
                    description: UUID of the user.
                  email:
                    type: string
                    example: info@publiq.be
                    description: The email address of the user.
                  username:
                    type: string
                    example: username
                    description: The username of the user.
                  id:
                    type: string
                    example: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    description: Deprecated, use `uuid` instead.
                    deprecated: true
                  nick:
                    type: string
                    example: username
                    description: Deprecated, use `username` instead.
                    deprecated: true
                required:
                - uuid
                - email
                - username
              examples:
                Example:
                  value:
                    uuid: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    email: info@publiq.be
                    username: username
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - USER_ACCESS_TOKEN: []
    servers:
    - url: https://io-test.uitdatabank.be
      description: Testing
    - url: https://io.uitdatabank.be
      description: Production
  /users/{userId}:
    parameters:
    - schema:
        type: string
      name: userId
      in: path
      description: The ID of the user you wish to search
      required: true
    get:
      summary: users - userid - get
      operationId: users-userId-get
      description: Returns the details of the user with the corresponding userId.
      tags:
      - Users
      responses:
        '200':
          description: The user details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: string
                    example: info@publiq.be
                    description: The email address of the user.
                  username:
                    type: string
                    example: username
                    description: The username of the user.
                  uuid:
                    type: string
                    example: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    format: uuid
                    description: UUID of the user.
                required:
                - email
                - username
                - uuid
              examples:
                Example:
                  value:
                    uuid: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    email: info@publiq.be
                    username: username
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - USER_ACCESS_TOKEN: []
      x-internal: true
    servers:
    - url: https://io-test.uitdatabank.be
      description: Testing
    - url: https://io.uitdatabank.be
      description: Production
  /users/emails/{email}:
    parameters:
    - schema:
        type: string
      name: email
      in: path
      required: true
      description: The e-mail of the user you wish to search
    get:
      summary: users - email - get
      operationId: users-email-get
      description: Returns the details of the user with the corresponding e-mail.
      tags:
      - Users
      responses:
        '200':
          description: The user details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  email:
                    type: string
                    example: info@publiq.be
                    description: The email address of the user.
                  username:
                    type: string
                    example: username
                    description: The username of the user.
                  uuid:
                    type: string
                    example: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    format: uuid
                    description: UUID of the user.
                required:
                - email
                - username
                - uuid
              examples:
                Example:
                  value:
                    uuid: c8e6ff82-8b30-4295-b937-ab2f4f6ab4bf
                    email: info@publiq.be
                    username: username
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
      - USER_ACCESS_TOKEN: []
      x-internal: true
    servers:
    - url: https://io-test.uitdatabank.be
      description: Testing
    - url: https://io.uitdatabank.be
      description: Production
components:
  responses:
    Unauthorized:
      description: 'Unauthorized. Your request is missing the required credentials to authenticate. See the Authentication documentation for more info.


        * type: https://api.publiq.be/probs/auth/unauthorized

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/unauthorized
                title: Unauthorized
                status: 401
    NotFound:
      description: 'The requested resource (URL) could not be found.

        This can be due to one of multiple reasons:


        * The endpoint has a typo and/or does not exist on the API

        * One of the path parameters contains a value that is invalid or does not exist

        * One of the required query parameters is missing

        * One of the query parameters has an invalid value


        The `detail` property of the response should contain more specific information.


        The `type` will always be `https://api.publiq.be/probs/url/not-found`.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/url/not-found
                title: URL not found
                status: 404
                detail: The resource with id "76C6AC08-763C-492E-A68C-CBC43A857229" was not found.
  schemas:
    Error:
      $ref: https://raw.githubusercontent.com/cultuurnet/apidocs/main/projects/errors/models/Error.json
    Error_2:
      title: Error
      type: object
      description: RFC7807 error model for all publiq APIs.
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type. Can be used to recognize specific errors in your application code by comparing the complete URI.
        title:
          type: string
          description: A short, human-readable summary of the problem type (for developers).
        status:
          type: integer
          description: The HTTP status code.
        detail:
          type: string
          description: 'A human-readable explanation specific to this occurrence of the problem (for developers). '
        endUserMessage:
          type: object
          description: A human-readable explanation of the problem, specifically for end-users, in one or more languages. Typically available for domain errors, but not for errors caused by a technical issue in the integration (for example invalid JSON syntax in a request body). An `nl` value is always provided, other languages may be provided depending on the API and its intended audience. When this property is included, it is strongly encouraged to show this to the end-user.
          properties:
            nl:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in Dutch.
            fr:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in French.
            de:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in German.
            en:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in English.
          required:
          - nl
        schemaErrors:
          type: array
          description: A list of one or more schema validation errors (usually used for error type https://api.publiq.be/probs/body/invalid-data).
          items:
            type: object
            properties:
              jsonPointer:
                type: string
                format: json-pointer
                description: RFC6901 compliant pointer that indicates what property/value was invalid.
              error:
                type: string
                description: A human-readable (but often technical) reason why the property was invalid.
            required:
            - jsonPointer
            - error
      required:
      - type
      - title
      - status
      x-internal: false
  securitySchemes:
    USER_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A user access token, obtained by redirecting the end user to publiq's authorization server to login using the **Authorization Code OAuth Flow**. See the [authentication docs about user access tokens](https://docs.publiq.be/docs/authentication/methods/client-access-token) for more info.
    CLIENT_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A client access token, obtained by exchanging your client id and client secret for a token via an HTTP request to publiq's authorization server using the **Client Credentials OAuth Flow**. See the [authentication docs about client access tokens](https://docs.publiq.be/docs/authentication/methods/user-access-token) for more info.
x-refined-from:
- uitdatabank-entry.json
- publiq-uitdatabank-entry-openapi.yml