fabric8-auth

swagger.yaml

basePath: /api
consumes:
- application/json
- application/x-www-form-urlencoded
definitions:
  AddManyCollaboratorsPayload:
    description: Holds the response of user idenitity IDs for updating list of user
      IDs
    example:
      data:
      - id: Atque consectetur atque.
        type: identities
      - id: Atque consectetur atque.
        type: identities
      included:
      - 3.15013e+18
      - 3.15013e+18
      - 3.15013e+18
    properties:
      data:
        example:
        - id: Atque consectetur atque.
          type: identities
        - id: Atque consectetur atque.
          type: identities
        items:
          $ref: '#/definitions/UpdateUserID'
        type: array
      included:
        description: An array of mixed types
        example:
        - 3.15013e+18
        - 3.15013e+18
        - 3.15013e+18
        items:
          example: 3.15013e+18
        type: array
    required:
    - data
    title: AddManyCollaboratorsPayload
    type: object
  AuthToken:
    description: JWT Token (default view)
    example:
      token:
        access_token: Beatae fuga enim suscipit sapiente vitae eligendi.
        expires_in: 1972-01-22T01:03:18Z
        not-before-policy: e15d3929-af77-459c-a9dd-cc6e531147c6
        refresh_expires_in: 5.4767466e+18
        refresh_token: Eum sed nobis provident aut quae occaecati.
        token_type: Consequatur quasi voluptatem non accusamus.
    properties:
      token:
        $ref: '#/definitions/TokenData'
    required:
    - token
    title: 'Mediatype identifier: application/vnd.authtoken+json; view=default'
    type: object
  AuthTokenCollection:
    description: AuthTokenCollection is the media type for an array of AuthToken (default
      view)
    example:
    - token:
        access_token: Beatae fuga enim suscipit sapiente vitae eligendi.
        expires_in: 1972-01-22T01:03:18Z
        not-before-policy: e15d3929-af77-459c-a9dd-cc6e531147c6
        refresh_expires_in: 5.4767466e+18
        refresh_token: Eum sed nobis provident aut quae occaecati.
        token_type: Consequatur quasi voluptatem non accusamus.
    - token:
        access_token: Beatae fuga enim suscipit sapiente vitae eligendi.
        expires_in: 1972-01-22T01:03:18Z
        not-before-policy: e15d3929-af77-459c-a9dd-cc6e531147c6
        refresh_expires_in: 5.4767466e+18
        refresh_token: Eum sed nobis provident aut quae occaecati.
        token_type: Consequatur quasi voluptatem non accusamus.
    - token:
        access_token: Beatae fuga enim suscipit sapiente vitae eligendi.
        expires_in: 1972-01-22T01:03:18Z
        not-before-policy: e15d3929-af77-459c-a9dd-cc6e531147c6
        refresh_expires_in: 5.4767466e+18
        refresh_token: Eum sed nobis provident aut quae occaecati.
        token_type: Consequatur quasi voluptatem non accusamus.
    items:
      $ref: '#/definitions/AuthToken'
    title: 'Mediatype identifier: application/vnd.authtoken+json; type=collection;
      view=default'
    type: array
  CreateIdentityDataAttributes:
    example:
      approved: true
      bio: Aut mollitia non consectetur error.
      cluster: Delectus aut.
      company: Fugit possimus quo neque ab.
      contextInformation:
        last_visited_url: https://a.openshift.io
        space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
      email: Sint esse distinctio.
      emailVerified: true
      enabled: false
      fullName: Debitis quam pariatur et dicta perspiciatis ut.
      imageURL: Officiis voluptas tenetur.
      providerType: Suscipit a.
      registrationCompleted: false
      rhd_user_id: Aspernatur et.
      rhd_username: Aut recusandae voluptatem consequatur maiores at.
      url: Doloribus recusandae non.
      username: Perspiciatis error.
    properties:
      approved:
        description: Whether the user is approved for using an OpenShift cluster.
          'True' is used by default
        example: true
        type: boolean
      bio:
        description: The bio
        example: Aut mollitia non consectetur error.
        type: string
      cluster:
        description: The OpenShift API URL of the cluster where the user is provisioned
          to
        example: Delectus aut.
        type: string
      company:
        description: The company
        example: Fugit possimus quo neque ab.
        type: string
      contextInformation:
        additionalProperties: true
        description: User context information of any type as a json
        example:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        type: object
      email:
        description: The email
        example: Sint esse distinctio.
        type: string
      emailVerified:
        description: Whether email is verified
        example: true
        type: boolean
      enabled:
        description: Whether the user is enabled
        example: false
        type: boolean
      fullName:
        description: The user's full name
        example: Debitis quam pariatur et dicta perspiciatis ut.
        type: string
      imageURL:
        description: The avatar image for the user
        example: Officiis voluptas tenetur.
        type: string
      providerType:
        description: The IDP provided this identity
        example: Suscipit a.
        type: string
      registrationCompleted:
        description: Whether the registration has been completed
        example: false
        type: boolean
      rhd_user_id:
        description: The Red Hat Developers User ID of the user
        example: Aspernatur et.
        type: string
      rhd_username:
        description: The associated Red Hat Developers account. If not set then username
          is used as the RHD username
        example: Aut recusandae voluptatem consequatur maiores at.
        type: string
      url:
        description: The url
        example: Doloribus recusandae non.
        type: string
      username:
        description: The username
        example: Perspiciatis error.
        type: string
    required:
    - username
    - email
    - cluster
    - rhd_user_id
    title: CreateIdentityDataAttributes
    type: object
  CreateUserData:
    example:
      attributes:
        approved: true
        bio: Aut mollitia non consectetur error.
        cluster: Delectus aut.
        company: Fugit possimus quo neque ab.
        contextInformation:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        email: Sint esse distinctio.
        emailVerified: true
        enabled: false
        fullName: Debitis quam pariatur et dicta perspiciatis ut.
        imageURL: Officiis voluptas tenetur.
        providerType: Suscipit a.
        registrationCompleted: false
        rhd_user_id: Aspernatur et.
        rhd_username: Aut recusandae voluptatem consequatur maiores at.
        url: Doloribus recusandae non.
        username: Perspiciatis error.
      links:
        meta:
          Tenetur et voluptate possimus.: true
        related: Itaque excepturi repellendus rerum tempore velit.
        self: Consectetur et saepe voluptas ex sit.
      type: Dolores eveniet molestias laudantium sequi hic perspiciatis.
    properties:
      attributes:
        $ref: '#/definitions/CreateIdentityDataAttributes'
      links:
        $ref: '#/definitions/GenericLinks'
      type:
        description: type of the user identity
        example: Dolores eveniet molestias laudantium sequi hic perspiciatis.
        type: string
    required:
    - type
    - attributes
    title: CreateUserData
    type: object
  CreateUsersPayload:
    description: User Create
    example:
      data:
        attributes:
          approved: true
          bio: Aut mollitia non consectetur error.
          cluster: Delectus aut.
          company: Fugit possimus quo neque ab.
          contextInformation:
            last_visited_url: https://a.openshift.io
            space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
          email: Sint esse distinctio.
          emailVerified: true
          enabled: false
          fullName: Debitis quam pariatur et dicta perspiciatis ut.
          imageURL: Officiis voluptas tenetur.
          providerType: Suscipit a.
          registrationCompleted: false
          rhd_user_id: Aspernatur et.
          rhd_username: Aut recusandae voluptatem consequatur maiores at.
          url: Doloribus recusandae non.
          username: Perspiciatis error.
        links:
          meta:
            Tenetur et voluptate possimus.: true
          related: Itaque excepturi repellendus rerum tempore velit.
          self: Consectetur et saepe voluptas ex sit.
        type: Dolores eveniet molestias laudantium sequi hic perspiciatis.
    properties:
      data:
        $ref: '#/definitions/CreateUserData'
    required:
    - data
    title: CreateUsersPayload
    type: object
  ExternalToken:
    description: Tokens from external providers such as GitHub or OpenShift (default
      view)
    example:
      access_token: Perspiciatis quibusdam dolor numquam.
      scope: Odit vel esse voluptas.
      token_type: Atque omnis magnam.
      username: Error sed.
    properties:
      access_token:
        description: The token associated with the identity for the specific external
          provider
        example: Perspiciatis quibusdam dolor numquam.
        type: string
      scope:
        description: The scope associated with the token
        example: Odit vel esse voluptas.
        type: string
      token_type:
        description: 'The type of the toke, example : bearer'
        example: Atque omnis magnam.
        type: string
      username:
        description: The username of the identity loaded from the specific external
          provider. Optional attribute.
        example: Error sed.
        type: string
    required:
    - access_token
    - scope
    - token_type
    title: 'Mediatype identifier: application/vnd.externaltoken+json; view=default'
    type: object
  GenericLinks:
    example:
      meta:
        Tenetur et voluptate possimus.: true
      related: Itaque excepturi repellendus rerum tempore velit.
      self: Consectetur et saepe voluptas ex sit.
    properties:
      meta:
        additionalProperties: true
        example:
          Tenetur et voluptate possimus.: true
        type: object
      related:
        example: Itaque excepturi repellendus rerum tempore velit.
        type: string
      self:
        example: Consectetur et saepe voluptas ex sit.
        type: string
    title: GenericLinks
    type: object
  JSONAPIError:
    description: |-
      Error objects provide additional information about problems encountered while
      performing an operation. Error objects MUST be returned as an array keyed by errors in the
      top level of a JSON API document.

      See. also http://jsonapi.org/format/#error-objects.
    example:
      code: Ad inventore at omnis.
      detail: Commodi voluptatem alias dolore est.
      id: Consequatur sit sit doloremque.
      links:
        Qui est quibusdam eaque.:
          href: http://example.com/articles/1/comments
          meta:
            Commodi architecto velit dolorem distinctio.: 7.0048935e+18
      meta:
        Quia sapiente est sed accusamus temporibus.: true
      source:
        Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
      status: Illum ut repellendus velit qui.
      title: Vero qui voluptatibus illum natus dignissimos.
    properties:
      code:
        description: an application-specific error code, expressed as a string value.
        example: Ad inventore at omnis.
        type: string
      detail:
        description: |-
          a human-readable explanation specific to this occurrence of the problem.
          Like title, this field’s value can be localized.
        example: Commodi voluptatem alias dolore est.
        type: string
      id:
        description: a unique identifier for this particular occurrence of the problem.
        example: Consequatur sit sit doloremque.
        type: string
      links:
        additionalProperties: true
        description: |-
          a links object containing the following members:
          * about: a link that leads to further details about this particular occurrence of the problem.
        example:
          Qui est quibusdam eaque.:
            href: http://example.com/articles/1/comments
            meta:
              Commodi architecto velit dolorem distinctio.: 7.0048935e+18
        type: object
      meta:
        additionalProperties: true
        description: a meta object containing non-standard meta-information about
          the error
        example:
          Quia sapiente est sed accusamus temporibus.: true
        type: object
      source:
        additionalProperties: true
        description: |-
          an object containing references to the source of the error,
          optionally including any of the following members

          * pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
                     or "/data/attributes/title" for a specific attribute].
          * parameter: a string indicating which URI query parameter caused the error.
        example:
          Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
        type: object
      status:
        description: the HTTP status code applicable to this problem, expressed as
          a string value.
        example: Illum ut repellendus velit qui.
        type: string
      title:
        description: |-
          a short, human-readable summary of the problem that SHOULD NOT
          change from occurrence to occurrence of the problem, except for purposes of localization.
        example: Vero qui voluptatibus illum natus dignissimos.
        type: string
    required:
    - detail
    title: JSONAPIError
    type: object
  JSONAPIErrors:
    description: JSONAPIErrors media type (default view)
    example:
      errors:
      - code: Ad inventore at omnis.
        detail: Commodi voluptatem alias dolore est.
        id: Consequatur sit sit doloremque.
        links:
          Qui est quibusdam eaque.:
            href: http://example.com/articles/1/comments
            meta:
              Commodi architecto velit dolorem distinctio.: 7.0048935e+18
        meta:
          Quia sapiente est sed accusamus temporibus.: true
        source:
          Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
        status: Illum ut repellendus velit qui.
        title: Vero qui voluptatibus illum natus dignissimos.
      - code: Ad inventore at omnis.
        detail: Commodi voluptatem alias dolore est.
        id: Consequatur sit sit doloremque.
        links:
          Qui est quibusdam eaque.:
            href: http://example.com/articles/1/comments
            meta:
              Commodi architecto velit dolorem distinctio.: 7.0048935e+18
        meta:
          Quia sapiente est sed accusamus temporibus.: true
        source:
          Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
        status: Illum ut repellendus velit qui.
        title: Vero qui voluptatibus illum natus dignissimos.
    properties:
      errors:
        example:
        - code: Ad inventore at omnis.
          detail: Commodi voluptatem alias dolore est.
          id: Consequatur sit sit doloremque.
          links:
            Qui est quibusdam eaque.:
              href: http://example.com/articles/1/comments
              meta:
                Commodi architecto velit dolorem distinctio.: 7.0048935e+18
          meta:
            Quia sapiente est sed accusamus temporibus.: true
          source:
            Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
          status: Illum ut repellendus velit qui.
          title: Vero qui voluptatibus illum natus dignissimos.
        - code: Ad inventore at omnis.
          detail: Commodi voluptatem alias dolore est.
          id: Consequatur sit sit doloremque.
          links:
            Qui est quibusdam eaque.:
              href: http://example.com/articles/1/comments
              meta:
                Commodi architecto velit dolorem distinctio.: 7.0048935e+18
          meta:
            Quia sapiente est sed accusamus temporibus.: true
          source:
            Commodi fugit et voluptas.: 2012-03-13T20:37:52Z
          status: Illum ut repellendus velit qui.
          title: Vero qui voluptatibus illum natus dignissimos.
        items:
          $ref: '#/definitions/JSONAPIError'
        type: array
    required:
    - errors
    title: 'Mediatype identifier: application/vnd.jsonapierrors+json; view=default'
    type: object
  OauthToken:
    description: Oauth 2.0 token payload (default view)
    example:
      access_token: Autem et et qui maiores.
      expiry: Voluptatem impedit rem eligendi consectetur.
      refresh_token: Rem error.
      token_type: Sunt deserunt repudiandae quod consectetur quia.
    properties:
      access_token:
        description: Access token
        example: Autem et et qui maiores.
        type: string
      expiry:
        description: Expiry
        example: Voluptatem impedit rem eligendi consectetur.
        type: string
      refresh_token:
        description: RefreshToken
        example: Rem error.
        type: string
      token_type:
        description: Token type
        example: Sunt deserunt repudiandae quod consectetur quia.
        type: string
    title: 'Mediatype identifier: application/vnd.oauthtoken+json; view=default'
    type: object
  PublicKeys:
    description: Public Keys (default view)
    example:
      keys:
      - 0.907251
    properties:
      keys:
        example:
        - 0.907251
        items:
          example: 0.907251
        type: array
    required:
    - keys
    title: 'Mediatype identifier: application/vnd.publickeys+json; view=default'
    type: object
  RedirectLocation:
    description: Redirect Location (default view)
    example:
      redirect_location: Illum ducimus et voluptatem.
    properties:
      redirect_location:
        description: The location which should be used to redirect browser
        example: Illum ducimus et voluptatem.
        type: string
    required:
    - redirect_location
    title: 'Mediatype identifier: application/vnd.redirectlocation+json; view=default'
    type: object
  RefreshToken:
    example:
      refresh_token: Cupiditate libero quod natus.
    properties:
      refresh_token:
        description: Refresh token
        example: Cupiditate libero quod natus.
        type: string
    title: RefreshToken
    type: object
  Register_resource:
    description: Response returned when a resource is registered (default view)
    example:
      _id: Iure iure nam.
    properties:
      _id:
        description: The identifier for the registered resource
        example: Iure iure nam.
        type: string
    title: 'Mediatype identifier: application/vnd.register_resource+json; view=default'
    type: object
  RegisterResourcePayload:
    description: A Protected Resource
    example:
      name: Distinctio ipsum ut nobis aperiam sit.
      parent_resource_id: Voluptatem accusamus.
      resource_id: Eos recusandae quod porro.
      resource_owner_id: Qui laudantium voluptatem assumenda ratione rem tempora.
      resource_scopes:
      - Blanditiis ratione corrupti nostrum autem debitis.
      type: Iusto maxime voluptas aliquid totam temporibus.
    properties:
      name:
        description: The name of the resource
        example: Distinctio ipsum ut nobis aperiam sit.
        type: string
      parent_resource_id:
        description: The parent resource (of the same type) to which this resource
          belongs
        example: Voluptatem accusamus.
        type: string
      resource_id:
        description: The identifier for this resource. If left blank, one will be
          generated
        example: Eos recusandae quod porro.
        type: string
      resource_owner_id:
        description: Identifier for the owner of the resource
        example: Qui laudantium voluptatem assumenda ratione rem tempora.
        type: string
      resource_scopes:
        description: The valid scopes for this resource
        example:
        - Blanditiis ratione corrupti nostrum autem debitis.
        items:
          example: Blanditiis ratione corrupti nostrum autem debitis.
          type: string
        type: array
      type:
        description: The type of resource
        example: Iusto maxime voluptas aliquid totam temporibus.
        type: string
    required:
    - resource_owner_id
    - name
    - type
    title: RegisterResourcePayload
    type: object
  RemoveManyCollaboratorsPayload:
    description: Holds the response of user idenitity IDs for updating list of user
      IDs
    example:
      data:
      - id: Atque consectetur atque.
        type: identities
      - id: Atque consectetur atque.
        type: identities
      included:
      - 3.15013e+18
      - 3.15013e+18
      - 3.15013e+18
    properties:
      data:
        example:
        - id: Atque consectetur atque.
          type: identities
        - id: Atque consectetur atque.
          type: identities
        items:
          $ref: '#/definitions/UpdateUserID'
        type: array
      included:
        description: An array of mixed types
        example:
        - 3.15013e+18
        - 3.15013e+18
        - 3.15013e+18
        items:
          example: 3.15013e+18
        type: array
    required:
    - data
    title: RemoveManyCollaboratorsPayload
    type: object
  Resource:
    description: A Protected Resource (default view)
    example:
      name: Distinctio ipsum ut nobis aperiam sit.
      parent_resource_id: Voluptatem accusamus.
      resource_id: Eos recusandae quod porro.
      resource_scopes:
      - Blanditiis ratione corrupti nostrum autem debitis.
      type: Iusto maxime voluptas aliquid totam temporibus.
    properties:
      name:
        description: The name of the resource
        example: Distinctio ipsum ut nobis aperiam sit.
        type: string
      parent_resource_id:
        description: The parent resource (of the same type) to which this resource
          belongs
        example: Voluptatem accusamus.
        type: string
      resource_id:
        description: The identifier for this resource. If left blank, one will be
          generated
        example: Eos recusandae quod porro.
        type: string
      resource_scopes:
        description: The valid scopes for this resource
        example:
        - Blanditiis ratione corrupti nostrum autem debitis.
        items:
          example: Blanditiis ratione corrupti nostrum autem debitis.
          type: string
        type: array
      type:
        description: The type of resource
        example: Iusto maxime voluptas aliquid totam temporibus.
        type: string
    required:
    - name
    - type
    title: 'Mediatype identifier: application/vnd.resource+json; view=default'
    type: object
  SpaceResource:
    description: Space Resource (default view)
    example:
      data:
        permissionID: Provident ab ea alias minus.
        policyID: Aut doloribus consequatur aut.
        resourceID: Est dolor libero.
    properties:
      data:
        $ref: '#/definitions/SpaceResourceData'
    required:
    - data
    title: 'Mediatype identifier: application/vnd.spaceresource+json; view=default'
    type: object
  SpaceResourceData:
    example:
      permissionID: Provident ab ea alias minus.
      policyID: Aut doloribus consequatur aut.
      resourceID: Est dolor libero.
    properties:
      permissionID:
        description: Keycloak Permission ID associated with this Space
        example: Provident ab ea alias minus.
        type: string
      policyID:
        description: Keycloak Policy ID associated with this Space
        example: Aut doloribus consequatur aut.
        type: string
      resourceID:
        description: Keycloak Resource ID associated with this Space
        example: Est dolor libero.
        type: string
    required:
    - resourceID
    - permissionID
    - policyID
    title: SpaceResourceData
    type: object
  Status:
    description: The status of the current running instance (default view)
    example:
      buildTime: Minus cupiditate adipisci omnis ex porro.
      commit: Illo voluptatem eligendi.
      configurationStatus: Quas autem eius suscipit laboriosam laborum voluptas.
      databaseStatus: Ut iusto cum voluptate.
      devMode: true
      startTime: Sit reprehenderit a ut et.
    properties:
      buildTime:
        description: The time when built
        example: Minus cupiditate adipisci omnis ex porro.
        type: string
      commit:
        description: Commit SHA this build is based on
        example: Illo voluptatem eligendi.
        type: string
      configurationStatus:
        description: The status of the used configuration. 'OK' or an error message
          if there is something wrong with the configuration used by service.
        example: Quas autem eius suscipit laboriosam laborum voluptas.
        type: string
      databaseStatus:
        description: The status of Database connection. 'OK' or an error message is
          displayed.
        example: Ut iusto cum voluptate.
        type: string
      devMode:
        description: '''True'' if the Developer Mode is enabled'
        example: true
        type: boolean
      startTime:
        description: The time when started
        example: Sit reprehenderit a ut et.
        type: string
    required:
    - commit
    - buildTime
    - startTime
    - databaseStatus
    - configurationStatus
    title: 'Mediatype identifier: application/vnd.status+json; view=default'
    type: object
  TokenData:
    example:
      access_token: Beatae fuga enim suscipit sapiente vitae eligendi.
      expires_in: 1972-01-22T01:03:18Z
      not-before-policy: e15d3929-af77-459c-a9dd-cc6e531147c6
      refresh_expires_in: 5.4767466e+18
      refresh_token: Eum sed nobis provident aut quae occaecati.
      token_type: Consequatur quasi voluptatem non accusamus.
    properties:
      access_token:
        description: Access token
        example: Beatae fuga enim suscipit sapiente vitae eligendi.
        type: string
      expires_in:
        description: Access token expires in seconds
        example: 1972-01-22T01:03:18Z
      not-before-policy:
        description: Token is not valid if issued before this date
        example: e15d3929-af77-459c-a9dd-cc6e531147c6
      refresh_expires_in:
        description: Refresh token expires in seconds
        example: 5.4767466e+18
      refresh_token:
        description: Refresh token
        example: Eum sed nobis provident aut quae occaecati.
        type: string
      token_type:
        description: Token type
        example: Consequatur quasi voluptatem non accusamus.
        type: string
    required:
    - expires_in
    - refresh_expires_in
    - not-before-policy
    title: TokenData
    type: object
  TokenExchange:
    example:
      client_id: Totam aut dignissimos distinctio eum est corrupti.
      client_secret: Maiores modi dolorem quaerat voluptas quia.
      code: Quia tenetur enim.
      grant_type: client_credentials
      redirect_uri: Aliquam aut omnis sint eveniet.
    properties:
      client_id:
        description: Service Account ID. Used to obtain a PAT for this service account.
        example: Totam aut dignissimos distinctio eum est corrupti.
        type: string
      client_secret:
        description: Service Account secret. Used to obtain a PAT for this service
          account.
        example: Maiores modi dolorem quaerat voluptas quia.
        type: string
      code:
        description: this is the authorization_code you received from /api/authorize
          endpoint
        example: Quia tenetur enim.
        type: string
      grant_type:
        description: Grant type. If set to "client_credentials" then this token exchange
          request is for a Protection API Token (PAT). PAT can be used to authenticate
          the corresponding Service Account. If the Grant Type is "authorization_code"
          we can use a authorization_code to get access_token
        enum:
        - client_credentials
        - authorization_code
        example: client_credentials
        type: string
      redirect_uri:
        description: Must be identical to the redirect URI provided while getting
          the authorization_code
        example: Aliquam aut omnis sint eveniet.
        type: string
    required:
    - grant_type
    - client_id
    title: TokenExchange
    type: object
  UpdateIdentityDataAttributes:
    example:
      bio: Consequatur repudiandae fugiat.
      company: Aliquid voluptas et modi.
      contextInformation:
        last_visited_url: https://a.openshift.io
        space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
      email: Adipisci autem rem fuga qui architecto.
      emailPrivate: false
      featureLevel: Sed officia nihil sed quas sequi.
      fullName: Occaecati voluptatum tempore quo modi ab.
      imageURL: Qui nobis dolor.
      registrationCompleted: false
      url: Quo similique culpa sint.
      username: Qui sint id labore.
    properties:
      bio:
        description: The bio
        example: Consequatur repudiandae fugiat.
        type: string
      company:
        description: The company
        example: Aliquid voluptas et modi.
        type: string
      contextInformation:
        additionalProperties: true
        description: User context information of any type as a json
        example:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        type: object
      email:
        description: The email
        example: Adipisci autem rem fuga qui architecto.
        type: string
      emailPrivate:
        description: Whether the email address would be private.
        example: false
        type: boolean
      featureLevel:
        description: The level of features that the user wants to use (for unreleased
          features)
        example: Sed officia nihil sed quas sequi.
        type: string
      fullName:
        description: The users full name
        example: Occaecati voluptatum tempore quo modi ab.
        type: string
      imageURL:
        description: The avatar image for the user
        example: Qui nobis dolor.
        type: string
      registrationCompleted:
        description: Complete the registration to proceed. This can only be set to
          true
        example: false
        type: boolean
      url:
        description: The url
        example: Quo similique culpa sint.
        type: string
      username:
        description: The username
        example: Qui sint id labore.
        type: string
    title: UpdateIdentityDataAttributes
    type: object
  UpdateUserData:
    example:
      attributes:
        bio: Consequatur repudiandae fugiat.
        company: Aliquid voluptas et modi.
        contextInformation:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        email: Adipisci autem rem fuga qui architecto.
        emailPrivate: false
        featureLevel: Sed officia nihil sed quas sequi.
        fullName: Occaecati voluptatum tempore quo modi ab.
        imageURL: Qui nobis dolor.
        registrationCompleted: false
        url: Quo similique culpa sint.
        username: Qui sint id labore.
      links:
        meta:
          Tenetur et voluptate possimus.: true
        related: Itaque excepturi repellendus rerum tempore velit.
        self: Consectetur et saepe voluptas ex sit.
      type: Adipisci rerum.
    properties:
      attributes:
        $ref: '#/definitions/UpdateIdentityDataAttributes'
      links:
        $ref: '#/definitions/GenericLinks'
      type:
        description: type of the user identity
        example: Adipisci rerum.
        type: string
    required:
    - type
    - attributes
    title: UpdateUserData
    type: object
  UpdateUserID:
    description: JSONAPI store for the data of a user identity ID. See also http://jsonapi.org/format/#document-resource-object
    example:
      id: Atque consectetur atque.
      type: identities
    properties:
      id:
        description: user identity ID
        example: Atque consectetur atque.
        type: string
      type:
        enum:
        - identities
        example: identities
        type: string
    required:
    - type
    - id
    title: UpdateUserID
    type: object
  UpdateUsersPayload:
    description: User Update
    example:
      data:
        attributes:
          bio: Consequatur repudiandae fugiat.
          company: Aliquid voluptas et modi.
          contextInformation:
            last_visited_url: https://a.openshift.io
            space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
          email: Adipisci autem rem fuga qui architecto.
          emailPrivate: false
          featureLevel: Sed officia nihil sed quas sequi.
          fullName: Occaecati voluptatum tempore quo modi ab.
          imageURL: Qui nobis dolor.
          registrationCompleted: false
          url: Quo similique culpa sint.
          username: Qui sint id labore.
        links:
          meta:
            Tenetur et voluptate possimus.: true
          related: Itaque excepturi repellendus rerum tempore velit.
          self: Consectetur et saepe voluptas ex sit.
        type: Adipisci rerum.
    properties:
      data:
        $ref: '#/definitions/UpdateUserData'
    required:
    - data
    title: UpdateUsersPayload
    type: object
  User:
    description: User Identity (default view)
    example:
      data:
        attributes:
          bio: Voluptas voluptatum nisi odio.
          cluster: Ducimus facilis molestiae.
          company: Quibusdam dolores optio consequatur excepturi non occaecati.
          contextInformation:
            last_visited_url: https://a.openshift.io
            space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
          created-at: 1986-03-12T22:46:07Z
          email: Deleniti fugit qui qui reiciendis veniam.
          emailPrivate: true
          emailVerified: false
          featureLevel: Perspiciatis soluta aut rerum illum tempora.
          fullName: Molestiae aut sit dolorum et error.
          identityID: Quos iusto provident.
          imageURL: Similique delectus maiores quidem hic veritatis distinctio.
          providerType: Exercitationem aut.
          registrationCompleted: true
          updated-at: 1991-08-17T15:44:06Z
          url: Amet deserunt ex laboriosam ex et rerum.
          userID: Deserunt saepe quia dicta placeat.
          username: Non hic voluptatum.
        id: Provident quia maiores voluptatem aut et ipsum.
        links:
          meta:
            Tenetur et voluptate possimus.: true
          related: Itaque excepturi repellendus rerum tempore velit.
          self: Consectetur et saepe voluptas ex sit.
        type: Quia amet.
    properties:
      data:
        $ref: '#/definitions/UserData'
    required:
    - data
    title: 'Mediatype identifier: application/vnd.user+json; view=default'
    type: object
  UserArray:
    description: User Array (default view)
    example:
      data:
      - attributes:
          bio: Voluptas voluptatum nisi odio.
          cluster: Ducimus facilis molestiae.
          company: Quibusdam dolores optio consequatur excepturi non occaecati.
          contextInformation:
            last_visited_url: https://a.openshift.io
            space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
          created-at: 1986-03-12T22:46:07Z
          email: Deleniti fugit qui qui reiciendis veniam.
          emailPrivate: true
          emailVerified: false
          featureLevel: Perspiciatis soluta aut rerum illum tempora.
          fullName: Molestiae aut sit dolorum et error.
          identityID: Quos iusto provident.
          imageURL: Similique delectus maiores quidem hic veritatis distinctio.
          providerType: Exercitationem aut.
          registrationCompleted: true
          updated-at: 1991-08-17T15:44:06Z
          url: Amet deserunt ex laboriosam ex et rerum.
          userID: Deserunt saepe quia dicta placeat.
          username: Non hic voluptatum.
        id: Provident quia maiores voluptatem aut et ipsum.
        links:
          meta:
            Tenetur et voluptate possimus.: true
          related: Itaque excepturi repellendus rerum tempore velit.
          self: Consectetur et saepe voluptas ex sit.
        type: Quia amet.
    properties:
      data:
        example:
        - attributes:
            bio: Voluptas voluptatum nisi odio.
            cluster: Ducimus facilis molestiae.
            company: Quibusdam dolores optio consequatur excepturi non occaecati.
            contextInformation:
              last_visited_url: https://a.openshift.io
              space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
            created-at: 1986-03-12T22:46:07Z
            email: Deleniti fugit qui qui reiciendis veniam.
            emailPrivate: true
            emailVerified: false
            featureLevel: Perspiciatis soluta aut rerum illum tempora.
            fullName: Molestiae aut sit dolorum et error.
            identityID: Quos iusto provident.
            imageURL: Similique delectus maiores quidem hic veritatis distinctio.
            providerType: Exercitationem aut.
            registrationCompleted: true
            updated-at: 1991-08-17T15:44:06Z
            url: Amet deserunt ex laboriosam ex et rerum.
            userID: Deserunt saepe quia dicta placeat.
            username: Non hic voluptatum.
          id: Provident quia maiores voluptatem aut et ipsum.
          links:
            meta:
              Tenetur et voluptate possimus.: true
            related: Itaque excepturi repellendus rerum tempore velit.
            self: Consectetur et saepe voluptas ex sit.
          type: Quia amet.
        items:
          $ref: '#/definitions/UserData'
        type: array
    required:
    - data
    title: 'Mediatype identifier: application/vnd.user-array+json; view=default'
    type: object
  UserData:
    example:
      attributes:
        bio: Voluptas voluptatum nisi odio.
        cluster: Ducimus facilis molestiae.
        company: Quibusdam dolores optio consequatur excepturi non occaecati.
        contextInformation:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        created-at: 1986-03-12T22:46:07Z
        email: Deleniti fugit qui qui reiciendis veniam.
        emailPrivate: true
        emailVerified: false
        featureLevel: Perspiciatis soluta aut rerum illum tempora.
        fullName: Molestiae aut sit dolorum et error.
        identityID: Quos iusto provident.
        imageURL: Similique delectus maiores quidem hic veritatis distinctio.
        providerType: Exercitationem aut.
        registrationCompleted: true
        updated-at: 1991-08-17T15:44:06Z
        url: Amet deserunt ex laboriosam ex et rerum.
        userID: Deserunt saepe quia dicta placeat.
        username: Non hic voluptatum.
      id: Provident quia maiores voluptatem aut et ipsum.
      links:
        meta:
          Tenetur et voluptate possimus.: true
        related: Itaque excepturi repellendus rerum tempore velit.
        self: Consectetur et saepe voluptas ex sit.
      type: Quia amet.
    properties:
      attributes:
        $ref: '#/definitions/UserDataAttributes'
      id:
        description: unique id for the user
        example: Provident quia maiores voluptatem aut et ipsum.
        type: string
      links:
        $ref: '#/definitions/GenericLinks'
      type:
        description: type of the user
        example: Quia amet.
        type: string
    required:
    - type
    - attributes
    title: UserData
    type: object
  UserDataAttributes:
    example:
      bio: Voluptas voluptatum nisi odio.
      cluster: Ducimus facilis molestiae.
      company: Quibusdam dolores optio consequatur excepturi non occaecati.
      contextInformation:
        last_visited_url: https://a.openshift.io
        space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
      created-at: 1986-03-12T22:46:07Z
      email: Deleniti fugit qui qui reiciendis veniam.
      emailPrivate: true
      emailVerified: false
      featureLevel: Perspiciatis soluta aut rerum illum tempora.
      fullName: Molestiae aut sit dolorum et error.
      identityID: Quos iusto provident.
      imageURL: Similique delectus maiores quidem hic veritatis distinctio.
      providerType: Exercitationem aut.
      registrationCompleted: true
      updated-at: 1991-08-17T15:44:06Z
      url: Amet deserunt ex laboriosam ex et rerum.
      userID: Deserunt saepe quia dicta placeat.
      username: Non hic voluptatum.
    properties:
      bio:
        description: The bio
        example: Voluptas voluptatum nisi odio.
        type: string
      cluster:
        description: The OpenShift API URL of the cluster where the user is provisioned
          to
        example: Ducimus facilis molestiae.
        type: string
      company:
        description: The company
        example: Quibusdam dolores optio consequatur excepturi non occaecati.
        type: string
      contextInformation:
        additionalProperties: true
        description: User context information of any type as a json
        example:
          last_visited_url: https://a.openshift.io
          space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
        type: object
      created-at:
        description: The date of creation of the user
        example: 1986-03-12T22:46:07Z
        format: date-time
        type: string
      email:
        description: The email
        example: Deleniti fugit qui qui reiciendis veniam.
        type: string
      emailPrivate:
        description: Whether the email address would be private.
        example: true
        type: boolean
      emailVerified:
        description: Whether the email is a verified one
        example: false
        type: boolean
      featureLevel:
        description: The level of features that the user wants to use (for unreleased
          features)
        example: Perspiciatis soluta aut rerum illum tempora.
        type: string
      fullName:
        description: The user's full name
        example: Molestiae aut sit dolorum et error.
        type: string
      identityID:
        description: The id of the corresponding Identity
        example: Quos iusto provident.
        type: string
      imageURL:
        description: The avatar image for the user
        example: Similique delectus maiores quidem hic veritatis distinctio.
        type: string
      providerType:
        description: The IDP provided this identity
        example: Exercitationem aut.
        type: string
      registrationCompleted:
        description: Whether the registration has been completed
        example: true
        type: boolean
      updated-at:
        description: The date of update of the user
        example: 1991-08-17T15:44:06Z
        format: date-time
        type: string
      url:
        description: The url
        example: Amet deserunt ex laboriosam ex et rerum.
        type: string
      userID:
        description: The id of the corresponding User
        example: Deserunt saepe quia dicta placeat.
        type: string
      username:
        description: The username
        example: Non hic voluptatum.
        type: string
    title: UserDataAttributes
    type: object
  UserList:
    description: Holds the paginated response to a user list request (default view)
    example:
      data:
      - attributes:
          bio: Voluptas voluptatum nisi odio.
          cluster: Ducimus facilis molestiae.
          company: Quibusdam dolores optio consequatur excepturi non occaecati.
          contextInformation:
            last_visited_url: https://a.openshift.io
            space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
          created-at: 1986-03-12T22:46:07Z
          email: Deleniti fugit qui qui reiciendis veniam.
          emailPrivate: true
          emailVerified: false
          featureLevel: Perspiciatis soluta aut rerum illum tempora.
          fullName: Molestiae aut sit dolorum et error.
          identityID: Quos iusto provident.
          imageURL: Similique delectus maiores quidem hic veritatis distinctio.
          providerType: Exercitationem aut.
          registrationCompleted: true
          updated-at: 1991-08-17T15:44:06Z
          url: Amet deserunt ex laboriosam ex et rerum.
          userID: Deserunt saepe quia dicta placeat.
          username: Non hic voluptatum.
        id: Provident quia maiores voluptatem aut et ipsum.
        links:
          meta:
            Tenetur et voluptate possimus.: true
          related: Itaque excepturi repellendus rerum tempore velit.
          self: Consectetur et saepe voluptas ex sit.
        type: Quia amet.
      included:
      - 2010-08-05T17:23:47Z
      links:
        filters: Consequatur aliquam.
        first: Voluptatem ad veritatis qui eos eum modi.
        last: Soluta omnis totam necessitatibus.
        next: Sint ea.
        prev: Qui animi et iure.
      meta:
        totalCount: 1.592527e+15
    properties:
      data:
        example:
        - attributes:
            bio: Voluptas voluptatum nisi odio.
            cluster: Ducimus facilis molestiae.
            company: Quibusdam dolores optio consequatur excepturi non occaecati.
            contextInformation:
              last_visited_url: https://a.openshift.io
              space: 3d6dab8d-f204-42e8-ab29-cdb1c93130ad
            created-at: 1986-03-12T22:46:07Z
            email: Deleniti fugit qui qui reiciendis veniam.
            emailPrivate: true
            emailVerified: false
            featureLevel: Perspiciatis soluta aut rerum illum tempora.
            fullName: Molestiae aut sit dolorum et error.
            identityID: Quos iusto provident.
            imageURL: Similique delectus maiores quidem hic veritatis distinctio.
            providerType: Exercitationem aut.
            registrationCompleted: true
            updated-at: 1991-08-17T15:44:06Z
            url: Amet deserunt ex laboriosam ex et rerum.
            userID: Deserunt saepe quia dicta placeat.
            username: Non hic voluptatum.
          id: Provident quia maiores voluptatem aut et ipsum.
          links:
            meta:
              Tenetur et voluptate possimus.: true
            related: Itaque excepturi repellendus rerum tempore velit.
            self: Consectetur et saepe voluptas ex sit.
          type: Quia amet.
        items:
          $ref: '#/definitions/UserData'
        type: array
      included:
        description: An array of mixed types
        example:
        - 2010-08-05T17:23:47Z
        items:
          example: 2010-08-05T17:23:47Z
        type: array
      links:
        $ref: '#/definitions/pagingLinks'
      meta:
        $ref: '#/definitions/UserListMeta'
    required:
    - data
    title: 'Mediatype identifier: application/vnd.userlist+json; view=default'
    type: object
  UserListMeta:
    example:
      totalCount: 1.592527e+15
    properties:
      totalCount:
        example: 1.592527e+15
        format: int64
        type: integer
    required:
    - totalCount
    title: UserListMeta
    type: object
  error:
    description: Error response media type (default view)
    example:
      code: invalid_value
      detail: Value of ID must be an integer
      id: 3F1FKVRR
      meta:
        timestamp: 1.458609e+09
      status: "400"
    properties:
      code:
        description: an application-specific error code, expressed as a string value.
        example: invalid_value
        type: string
      detail:
        description: a human-readable explanation specific to this occurrence of the
          problem.
        example: Value of ID must be an integer
        type: string
      id:
        description: a unique identifier for this particular occurrence of the problem.
        example: 3F1FKVRR
        type: string
      meta:
        additionalProperties: true
        description: a meta object containing non-standard meta-information about
          the error.
        example:
          timestamp: 1.458609e+09
        type: object
      status:
        description: the HTTP status code applicable to this problem, expressed as
          a string value.
        example: "400"
        type: string
    title: 'Mediatype identifier: application/vnd.goa.error; view=default'
    type: object
  pagingLinks:
    example:
      filters: Consequatur aliquam.
      first: Voluptatem ad veritatis qui eos eum modi.
      last: Soluta omnis totam necessitatibus.
      next: Sint ea.
      prev: Qui animi et iure.
    properties:
      filters:
        example: Consequatur aliquam.
        type: string
      first:
        example: Voluptatem ad veritatis qui eos eum modi.
        type: string
      last:
        example: Soluta omnis totam necessitatibus.
        type: string
      next:
        example: Sint ea.
        type: string
      prev:
        example: Qui animi et iure.
        type: string
    title: pagingLinks
    type: object
host: openshift.io
info:
  description: The next big thing
  license:
    name: Apache License Version 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
  title: 'Fabric8-auth: One to rule them all'
  version: "1.0"
paths:
  /authorize:
    get:
      description: Authorize service client
      operationId: authorize#authorize
      parameters:
      - description: The name of the api client which is requesting a token
        in: query
        name: api_client
        required: false
        type: string
      - in: query
        name: client_id
        required: true
        type: string
      - description: This is where authorization provider will send authorization_code
        in: query
        name: redirect_uri
        required: true
        type: string
      - description: response_type=code for grant_type authorization_code
        enum:
        - code
        in: query
        name: response_type
        required: true
        type: string
      - in: query
        name: scope
        required: false
        type: string
      - in: query
        name: state
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: authorize authorize
      tags:
      - authorize
  /authorize/callback:
    get:
      description: Authorize service client callback
      operationId: authorize#callback
      parameters:
      - description: authorization_code
        in: query
        name: code
        required: true
        type: string
      - in: query
        name: state
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: callback authorize
      tags:
      - authorize
  /link:
    get:
      description: Link an Identity Provider account to the user account
      operationId: link#link
      parameters:
      - description: Identity Provider name to link to the user's account. If not
          set then link all available providers.
        in: query
        name: provider
        required: false
        type: string
      - description: URL to be redirected to after successful account linking. If
          not set then will redirect to the referrer instead.
        in: query
        name: redirect
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: link link
      tags:
      - link
  /link/callback:
    get:
      description: Callback from Keyckloak when Identity Provider account successfully
        linked to the user account
      operationId: link#callback
      parameters:
      - description: Next provider to be linked. If not set then linking is complete.
        in: query
        name: next
        required: false
        type: string
      - description: Session state
        in: query
        name: sessionState
        required: false
        type: string
      - description: State generated by the link request
        in: query
        name: state
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: callback link
      tags:
      - link
  /link/session:
    get:
      description: Link an Identity Provider account to the user account represented
        by user's session. This endpoint is to be used for auto linking during login.
      operationId: link#session
      parameters:
      - description: Identity Provider name to link to the user's account. If not
          set then link all available providers.
        in: query
        name: provider
        required: false
        type: string
      - description: URL to be redirected to after successful account linking. If
          not set then will redirect to the referrer instead.
        in: query
        name: redirect
        required: false
        type: string
      - description: Session state
        in: query
        name: sessionState
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: session link
      tags:
      - link
  /login:
    get:
      description: Login user
      operationId: login#login
      parameters:
      - description: The name of the api client which is requesting a token
        in: query
        name: api_client
        required: false
        type: string
      - description: URL to be redirected to after successful login. If not set then
          will redirect to the referrer instead.
        in: query
        name: redirect
        required: false
        type: string
      - description: If scope=offline_access then an offline token will be issued
          instead of a regular refresh token
        enum:
        - offline_access
        in: query
        name: scope
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: login login
      tags:
      - login
  /logout:
    get:
      description: Logout user
      operationId: logout#logout
      parameters:
      - description: URL to be redirected to after successful logout. If not set then
          will redirect to the referrer instead.
        in: query
        name: redirect
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: logout logout
      tags:
      - logout
  /resource:
    post:
      description: Register a new resource
      operationId: resource#register
      parameters:
      - description: A Protected Resource
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/RegisterResourcePayload'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.register_resource+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/Register_resource'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: register resource
      tags:
      - resource
  /resource/{resourceId}:
    delete:
      description: Delete a resource
      operationId: resource#delete
      parameters:
      - description: Identifier of the resource to delete
        in: path
        name: resourceId
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "405":
          description: Method Not Allowed
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: delete resource
      tags:
      - resource
    get:
      description: Read a specific resource
      operationId: resource#read
      parameters:
      - description: The identifier of the resource to read
        in: path
        name: resourceId
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.resource+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/Resource'
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: read resource
      tags:
      - resource
    put:
      description: Update the details of the specified resource
      operationId: resource#update
      parameters:
      - description: Identifier of the resource to update
        in: path
        name: resourceId
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "403":
          description: Forbidden
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "405":
          description: Method Not Allowed
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: update resource
      tags:
      - resource
  /search/users:
    get:
      description: Search by fullname
      operationId: search#users
      parameters:
      - description: Paging size
        in: query
        name: page[limit]
        required: false
        type: integer
      - description: Paging start position
        in: query
        name: page[offset]
        required: false
        type: string
      - in: query
        name: q
        required: true
        type: string
      produces:
      - application/vnd.goa.error
      - application/vnd.userlist+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/UserList'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/error'
        "500":
          description: Internal Server Error
      schemes:
      - http
      summary: users search
      tags:
      - search
  /spaces/{spaceID}:
    delete:
      description: Delete a space resource for the given space ID
      operationId: space#delete
      parameters:
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "403":
          description: Forbidden
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: delete space
      tags:
      - space
    post:
      description: Create a space resource for the giving space
      operationId: space#create
      parameters:
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.spaceresource+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/SpaceResource'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: create space
      tags:
      - space
  /spaces/{spaceID}/collaborators:
    delete:
      description: Remove users form the list of space collaborators.
      operationId: collaborators#remove-many
      parameters:
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      - description: Holds the response of user idenitity IDs for updating list of
          user IDs
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/RemoveManyCollaboratorsPayload'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: remove-many collaborators
      tags:
      - collaborators
    get:
      description: List collaborators for the given space ID.
      operationId: collaborators#list
      parameters:
      - description: Paging size
        in: query
        name: page[limit]
        required: false
        type: integer
      - description: Paging start position
        in: query
        name: page[offset]
        required: false
        type: string
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      - in: header
        name: If-Modified-Since
        required: false
        type: string
      - in: header
        name: If-None-Match
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.userlist+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/UserList'
        "304":
          description: Not Modified
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: list collaborators
      tags:
      - collaborators
    post:
      description: Add users to the list of space collaborators.
      operationId: collaborators#add-many
      parameters:
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      - description: Holds the response of user idenitity IDs for updating list of
          user IDs
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/AddManyCollaboratorsPayload'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: add-many collaborators
      tags:
      - collaborators
  /spaces/{spaceID}/collaborators/{identityID}:
    delete:
      description: Remove a user from the list of space collaborators.
      operationId: collaborators#remove
      parameters:
      - in: path
        name: identityID
        required: true
        type: string
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: remove collaborators
      tags:
      - collaborators
    post:
      description: Add a user to the list of space collaborators.
      operationId: collaborators#add
      parameters:
      - in: path
        name: identityID
        required: true
        type: string
      - description: ID of the space
        in: path
        name: spaceID
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: add collaborators
      tags:
      - collaborators
  /status:
    get:
      description: Show the status of the current running instance
      operationId: status#show
      produces:
      - application/vnd.status+json
      - application/vnd.status+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/Status'
        "503":
          description: Service Unavailable
          schema:
            $ref: '#/definitions/Status'
      schemes:
      - http
      summary: show status
      tags:
      - status
  /token:
    delete:
      description: Delete the external token for resources belonging to external providers
        like Github and OpenShift
      operationId: token#Delete
      parameters:
      - description: The resource for which the external token is being deleted, example
          https://github.com/fabric8-services/fabric8-auth or https://api.starter-us-east-2.openshift.com
        in: query
        name: for
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - text/plain
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: Delete token
      tags:
      - token
    get:
      description: Get the external token for resources belonging to external providers
        like Github and OpenShift
      operationId: token#Retrieve
      parameters:
      - description: The resource for which the external token is being fetched, example
          https://github.com/fabric8-services/fabric8-auth or https://api.starter-us-east-2.openshift.com
        in: query
        name: for
        required: true
        type: string
      - description: Pull the user's details for the specific connected account, example,
          the user's updated github username would be fetched from github. If this
          is not set or false, then the user profile will be pulled only if the stored
          user's details did not have the username
        in: query
        name: force_pull
        required: false
        type: boolean
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.externaltoken+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/ExternalToken'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: Retrieve token
      tags:
      - token
    post:
      description: Obtain a security token
      operationId: token#Exchange
      parameters:
      - in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/TokenExchange'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.oauthtoken+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/OauthToken'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: Exchange token
      tags:
      - token
  /token/generate:
    get:
      description: Generate a set of Tokens for different Auth levels. NOT FOR PRODUCTION.
        Only available if server is running in dev mode
      operationId: token#generate
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.authtoken+json; type=collection
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/AuthTokenCollection'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: generate token
      tags:
      - token
  /token/keys:
    get:
      description: Returns public keys which should be used to verify tokens
      operationId: token#keys
      parameters:
      - description: Key format. If set to "jwk" (used by default) then JSON Web Key
          format will be used. If "pem" then a PEM-like format (PEM without header
          and footer) will be used.
        enum:
        - pem
        - jwk
        in: query
        name: format
        required: false
        type: string
      produces:
      - application/vnd.publickeys+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/PublicKeys'
      schemes:
      - http
      summary: keys token
      tags:
      - token
  /token/link:
    get:
      description: Get a redirect location which should be used to initiate account
        linking between the user account and an external resource provider such as
        GitHub
      operationId: token#link
      parameters:
      - description: Resource we need to link accounts for. Multiple resources should
          be separated by comma.
        in: query
        name: for
        required: true
        type: string
      - description: URL to be redirected to after successful account linking. If
          not set then will redirect to the referrer instead.
        in: query
        name: redirect
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.redirectlocation+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/RedirectLocation'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: link token
      tags:
      - token
  /token/link/callback:
    get:
      description: Callback from an external oauth2 resource provider such as GitHub
        as part of user's account linking
      operationId: token#callback
      parameters:
      - description: Code provided by an external oauth2 resource provider
        in: query
        name: code
        required: true
        type: string
      - description: State generated by the link request
        in: query
        name: state
        required: true
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      responses:
        "307":
          description: Temporary Redirect
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: callback token
      tags:
      - token
  /token/refresh:
    post:
      description: Refresh access token
      operationId: token#refresh
      parameters:
      - in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/RefreshToken'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.authtoken+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/AuthToken'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: refresh token
      tags:
      - token
  /user:
    get:
      description: Get the authenticated user
      operationId: user#show
      parameters:
      - in: header
        name: If-Modified-Since
        required: false
        type: string
      - in: header
        name: If-None-Match
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.user+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/User'
        "304":
          description: Not Modified
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: show user
      tags:
      - user
  /users:
    get:
      description: List all users.
      operationId: users#list
      parameters:
      - description: email to search users
        in: query
        name: filter[email]
        required: false
        type: string
      - description: username to search users
        in: query
        name: filter[username]
        required: false
        type: string
      - in: header
        name: If-Modified-Since
        required: false
        type: string
      - in: header
        name: If-None-Match
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.user-array+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/UserArray'
        "304":
          description: Not Modified
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: list users
      tags:
      - users
    patch:
      description: update the authenticated user
      operationId: users#update
      parameters:
      - description: User Update
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/UpdateUsersPayload'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.user+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/User'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "403":
          description: Forbidden
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "409":
          description: Conflict
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: update users
      tags:
      - users
    post:
      description: create a user using a service account
      operationId: users#Create
      parameters:
      - description: User Create
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/CreateUsersPayload'
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.user+json
      - application/vnd.jsonapierrors+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/User'
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "401":
          description: Unauthorized
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "409":
          description: Conflict
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      security:
      - jwt: []
      summary: Create users
      tags:
      - users
  /users/{id}:
    get:
      description: Retrieve user for the given ID.
      operationId: users#show
      parameters:
      - description: id
        in: path
        name: id
        required: true
        type: string
      - in: header
        name: If-Modified-Since
        required: false
        type: string
      - in: header
        name: If-None-Match
        required: false
        type: string
      produces:
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.jsonapierrors+json
      - application/vnd.user+json
      responses:
        "200":
          description: Resource created
          headers:
            Cache-Control:
              type: string
            ETag:
              type: string
            Last-Modified:
              type: string
          schema:
            $ref: '#/definitions/User'
        "304":
          description: Not Modified
        "400":
          description: Bad Request
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/JSONAPIErrors'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/JSONAPIErrors'
      schemes:
      - http
      summary: show users
      tags:
      - users
  /users/verifyemail:
    get:
      description: Verify if the new email updated by the user is a valid email
      operationId: users#verifyEmail
      parameters:
      - description: code
        in: query
        name: code
        required: true
        type: string
      responses:
        "307":
          description: Temporary Redirect
      schemes:
      - http
      summary: verifyEmail users
      tags:
      - users
produces:
- application/json
- application/x-www-form-urlencoded
responses:
  InternalServerError:
    description: Internal Server Error
  MethodNotAllowed:
    description: Method Not Allowed
  NotModified:
    description: Not Modified
  OK:
    description: Resource created
    headers:
      Cache-Control:
        type: string
      ETag:
        type: string
      Last-Modified:
        type: string
  TemporaryRedirect:
    description: Temporary Redirect
schemes:
- http
securityDefinitions:
  jwt:
    description: |-
      JWT Token Auth

      **Token URL**: http://openshift.io/api/login
    in: header
    name: Authorization
    type: apiKey
swagger: "2.0"