Mend Administration - Users API

openapi: 3.2.0
info:
  title: Mend Administration - Users API
  version: '1.0'
  description: 'Operations tagged Administration - Users across 2 of this provider''s published API definitions: mend-openapi.json, mend-platform-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-saas.mend.io
  description: Generated server url
- url: https://baseUrl
  description: Generated server url
security:
- bearer-key: []
tags:
- name: Administration - Users
paths:
  /api/v3.0/orgs/{orgUuid}/users/{userUuid}/unblock:
    put:
      tags:
      - Administration - Users
      summary: Unblock User
      description: Unblocks a user in the organization
      operationId: unblockUser
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: userUuid
        in: path
        description: User UUID (Administration > Users)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3Boolean'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/orgs/{orgUuid}/users/{userUuid}/block:
    put:
      tags:
      - Administration - Users
      summary: Block User
      description: Blocks a user in the organization
      operationId: blockUser
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: userUuid
        in: path
        description: User UUID (Administration > Users)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3Boolean'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/orgs/{orgUuid}/users/invite:
    post:
      tags:
      - Administration - Users
      summary: Invite User
      description: Sends an email invitation to others to join an organization
      operationId: inviteUser
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteUserRequestDTO'
        required: true
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3UserInfoResponseDTO'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/users:
    get:
      tags:
      - Administration - Users
      summary: Check if SSO login is enforced for user
      description: Return true if SSO login is enforced
      operationId: checkIfSsoLoginEnforced
      parameters:
      - name: userEmail
        in: query
        description: User Email Address
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3UserDataDTO'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/orgs/{orgUuid}/users:
    get:
      tags:
      - Administration - Users
      summary: Get Organization Users
      description: Returns a list of all users in an organization (paginated)
      operationId: getUsersPaginated
      parameters:
      - name: cursor
        in: query
        description: Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved
        allowEmptyValue: true
        schema:
          type: string
          default: '0'
      - name: limit
        in: query
        description: Specifies the maximum number of items to be return in the response.
        allowEmptyValue: true
        schema:
          maximum: 10000
          type: string
          default: '50'
      - name: search
        in: query
        description: "Filter your search to return items whose property has a specific value.\nUse the syntax: **[property][operator][value]**\n+ **Property**: the name of the property of the item\n+ **Operator**:\n    + **equals (==)** - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator).\nExample: entity==abc* — will return true for entities like \"abcd\" and \"abc_123\".\n    + **in (=in=)** - Returns true if the value matches any item in the comma-separated list.\nExample: entity=in=value1,value2 — will return true for entities which are either value1, or value2.\n    + **regex (=rgx=)** - Returns true if the regular expression resolves as true.\n        The regex is not case sensitive, and special characters must be escaped with a backslash.\n        Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n        To pass an escaped character in a URL in Postman, encode it first.\n        E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ **Value**: the value of the property.\n\nLogical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ accountStatus: equals, in\n+ email: equals, regex\n+ UUID: equals\n+ name: equals, regex\n+ userType: equals, in\n+ roles: equals, in"
        allowEmptyValue: true
        schema:
          type: string
      - name: sort
        in: query
        description: 'Sort search results alphabetically on an item''s property by entering **sort=** followed by the property name.

          E.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign (''-''). E.g. **sort=-email**.


          You can sort by the following properties:

          + email

          + name

          + userType'
        allowEmptyValue: true
        schema:
          type: string
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponsePageableV3ListUserInfoDTOV3'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
  /api/v3.0/orgs/{orgUuid}/users/{userUuid}:
    delete:
      tags:
      - Administration - Users
      summary: Remove User From Organization
      description: Deletes a user from an organization
      operationId: removeUser
      parameters:
      - name: orgUuid
        in: path
        description: Org UUID (Administration > General)
        required: true
        schema:
          type: string
      - name: userUuid
        in: path
        description: User UUID (Administration > Users)
        required: true
        schema:
          type: string
      responses:
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DWRResponseBase'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DWRResponseV3MessageDTO'
    servers:
    - url: https://api-saas.mend.io
      description: Generated server url
components:
  schemas:
    UserInfoResponseDTO:
      required:
      - uuid
      type: object
      properties:
        uuid:
          title: User UUID
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
        name:
          title: User Name
          type: string
          example: Jon Smith
        email:
          title: User Email
          type: string
          example: jon.smith@mail.com
        userType:
          title: Type Of User
          type: string
          example: REGULAR
          enum:
          - REGULAR
          - SERVICE
          - SCAN_SUMMARY_RECEIVER
        existsInOrg:
          type: boolean
    DWRResponseV3UserInfoResponseDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/UserInfoResponseDTO'
    DWRResponseV3UserDataDTO:
      type: object
      properties:
        additionalData:
          type: object
          additionalProperties:
            type: object
        supportToken:
          type: string
        response:
          $ref: '#/components/schemas/UserDataDTO'
    DWRResponseBase:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
    UserInfoDTOV3:
      required:
      - uuid
      type: object
      properties:
        uuid:
          title: User UUID
          type: string
          example: 123e4567-e89b-12d3-a456-426655440000
        name:
          title: User Name
          type: string
          example: Jon Smith
        email:
          title: User Email
          type: string
          example: jon.smith@mail.com
        userType:
          title: Type Of User
          type: string
          example: REGULAR
          enum:
          - REGULAR
          - SERVICE
          - SCAN_SUMMARY_RECEIVER
        accountStatus:
          title: User Account Status
          type: string
          example: ACTIVE
          enum:
          - ACTIVE
          - INVITED
          - DISABLED
    InviteUserRequestDTO:
      required:
      - email
      type: object
      properties:
        email:
          title: New User Email
          type: string
          example: jon.smith@mail.com
    DWRResponseV3Boolean:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: boolean
    MessageDTO:
      type: object
      properties:
        message:
          title: message
          type: string
          example: Success!
    DWRResponseV3MessageDTO:
      type: object
      properties:
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          $ref: '#/components/schemas/MessageDTO'
    UserDataDTO:
      type: object
      properties:
        ssoLoginEnforced:
          type: boolean
    DWRResponsePageableV3ListUserInfoDTOV3:
      type: object
      properties:
        additionalData:
          title: Provides insights into endpoint-supported pagination information.
          type: object
          description: '+ **totalItems**: The total count of data points returned in an API response.

            '
          example:
            totalItems: '422'
            next: http://someUrl?cursor=3
            cursor: 3
        supportToken:
          title: Support Token
          type: string
          example: 1171c60d
        response:
          type: array
          items:
            $ref: '#/components/schemas/UserInfoDTOV3'
  securitySchemes:
    bearer-key:
      type: http
      description: JWT token Bearer
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- mend-openapi.json
- mend-platform-openapi-original.json