Basware

Basware UserGroupAssociatedUsers API

The UserGroupAssociatedUsers API from Basware — 1 operation(s) for usergroupassociatedusers.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 3

POST /v1/userGroupAssociatedUsers Associates users with userGroup #
GET /v1/userGroupAssociatedUsers Returns user associations with user Groups #
DELETE /v1/userGroupAssociatedUsers Deletes user association with user group #

Documentation

📖
Documentation
https://developer.basware.com/en/api/basware/manual
📖
GettingStarted
https://developer.basware.com/en/api/basware/get-started
📖
Documentation
https://developer.basware.com/en/api/network/guide
📖
GettingStarted
https://developer.basware.com/en/api/network/get-started
📖
Documentation
https://developer.basware.com/en/api/vault/manual
📖
GettingStarted
https://developer.basware.com/en/api/vault

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/basware/refs/heads/main/openapi/basware-usergroupassociatedusers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/basware-usergroupassociatedusers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

basware-usergroupassociatedusers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: User Permission Management User Group Associated Users API
  description: 'This set of APIs allows managing user groups and associating users to the user groups. These user groups grant granular user permissions across Basware applications. The permissions granted by the user groups are managed in Basware Admin application.


    Each of the managed applications needs to support permission management through cross application user groups and be configured to have cross application user groups enabled. Supported applications include AP Automation, SmartPDF and Vault.'
  version: v1
servers:
- url: ''
security:
- Bearer: []
- oauth2authentication: []
tags:
- name: UserGroupAssociatedUsers
paths:
  /v1/userGroupAssociatedUsers:
    post:
      tags:
      - UserGroupAssociatedUsers
      summary: Associates users with userGroup
      parameters:
      - name: Content-Type
        in: header
        description: Specifies the media type of the resource. Value application/json is supported.
        schema:
          type: string
        example: application/json
      requestBody:
        description: External code of the user associated to the user group.
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserGroupAssociatedUser'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserGroupAssociatedUser'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserGroupAssociatedUser'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserGroupAssociatedUser'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/IModelValidationResult'
            application/json:
              schema:
                $ref: '#/components/schemas/IModelValidationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/IModelValidationResult'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      operationId: postV1UserGroupAssociatedUsers
      x-operation-id-source: derived
    get:
      tags:
      - UserGroupAssociatedUsers
      summary: Returns user associations with user Groups
      parameters:
      - name: UserGroupExternalCode
        in: query
        schema:
          type: string
      - name: UserExternalCode
        in: query
        schema:
          type: string
      - name: x-amz-meta-continuationToken
        in: header
        description: Used to get next page of results when item count indicated by 'pageSize' is exceeded. A token is returned in header (not body) parameter 'X-amz-meta-continuationToken' of the response whenever there are more records to fetch. Post the received value here in a new HEADER parameter on the next GET request to receive the next page of results. When getting the next page of results, you must include the same query parameters that were used when getting the first page.
        schema:
          type: string
        example: 00fbeb94-7644-4877-8086-d5a22fd299b1
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserGroupAssociatedUser'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      operationId: getV1UserGroupAssociatedUsers
      x-operation-id-source: derived
    delete:
      tags:
      - UserGroupAssociatedUsers
      summary: Deletes user association with user group
      description: 'For manual one-time operations only, such as a manual clean-up to remove test data generated during API integration development. Only removes records from API layer.

        Deletion in target systems needs to be done separately using the data deletion mechanisms available in each of the target system in addition to deleting the data in Basware API.'
      requestBody:
        description: "Contains the body of the request.\n            If both (userGroupExternalCode and UserExternalCode) values are provided then the record will be deleted directly, else delete lambda will be triggered."
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/UserGroupAssociationsDeleteRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupAssociationsDeleteRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UserGroupAssociationsDeleteRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserGroupAssociationsDeleteRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '202':
          description: RequestAccepted
        '500':
          description: Unexpected error
      operationId: deleteV1UserGroupAssociatedUsers
      x-operation-id-source: derived
components:
  schemas:
    IModelValidationResult:
      type: object
      properties:
        requestId:
          type:
          - string
          - 'null'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IModelValidationError'
          readOnly: true
        hasErrors:
          type: boolean
          readOnly: true
      additionalProperties: false
    UserGroupAssociatedUser:
      required:
      - userExternalCode
      - userGroupExternalCode
      type: object
      properties:
        userGroupExternalCode:
          maxLength: 100
          minLength: 1
          type: string
          description: External code of the user group to which the user is associated.
          example: IND_Admins
        userExternalCode:
          maxLength: 100
          minLength: 1
          type: string
          description: External code of the user associated to the user group.
          example: joe@basware.com
      additionalProperties: false
    UserGroupAssociationsDeleteRequest:
      type: object
      properties:
        userGroupExternalCode:
          maxLength: 36
          minLength: 0
          type:
          - string
          - 'null'
        userExternalCode:
          maxLength: 36
          minLength: 0
          type:
          - string
          - 'null'
        lastUpdated:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    IModelValidationError:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        externalCode:
          type:
          - string
          - 'null'
        info:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        cdmErrorMappingOrganizationCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    BulkOperationStatus:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
      description: Represents the possible statuses of a bulk operation.
      format: int32
    DeleteResponse:
      type: object
      properties:
        statusApiLink:
          type:
          - string
          - 'null'
          description: Gets or sets the API link to check the status of the delete operation.
        taskName:
          type:
          - string
          - 'null'
          description: Gets or sets the name of the delete task.
        taskStatus:
          type:
          - string
          - 'null'
          description: Gets or sets the current status of the delete task.
          readOnly: true
        statusEnum:
          $ref: '#/components/schemas/BulkOperationStatus'
      additionalProperties: false
      description: Represents the response returned after a delete operation.
  securitySchemes:
    Bearer:
      type: http
      description: Please insert basic authentication credentials into fields
      scheme: basic
    oauth2authentication:
      type: oauth2
      description: OAuth2 client credentials flow.
      flows:
        clientCredentials:
          tokenUrl: https://api.basware.com/v1/tokens
          scopes:
            userGroups.read: GET user groups
            userGroups.write: POST user groups
            userGroups.delete: DELETE user groups
            userGroupAssociatedUsers.read: GET user associations with user group
            userGroupAssociatedUsers.write: POST user associations to user group
            userGroupAssociatedUsers.delete: DELETE user associations from user group