Alianza User Groups API

Operations for managing user groups.

Operations 4

GET /v2/user-groups/settings Get user groups #
POST /v2/user-groups/settings Create user group #
PUT /v2/user-groups/settings Update user group #
DELETE /v2/user-groups/settings Delete user group #

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/alianza-user-groups-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.

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

OpenAPI Specification

alianza-user-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Alianza User Groups API
  version: '2'
  description: 'Operations tagged User Groups across 2 of this provider''s published API definitions: alianza-openapi-original.yml, alianza-user-groups-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
security:
- X-Auth-Token: []
tags:
- name: User Groups
  description: Operations for managing user groups.
paths:
  /v2/user-groups/settings:
    servers:
    - url: https://api.d2.alianza.com
      description: Development
    - url: https://api.q2.alianza.com
      description: QA
    - url: https://api.b2.alianza.com
      description: Beta
    - url: https://api.alianza.com
      description: Production
    get:
      tags:
      - User Groups
      summary: Get user groups
      operationId: getUserGroups
      parameters:
      - name: partitionId
        in: query
        required: true
        schema:
          type: string
      - name: accountId
        in: query
        required: true
        schema:
          type: string
      - name: groupId
        in: query
        required: false
        schema:
          type: string
      - name: userId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
        '204':
          description: No content – operation completed successfully
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    post:
      tags:
      - User Groups
      summary: Create user group
      operationId: createUserGroup
      parameters:
      - name: partitionId
        in: query
        required: true
        schema:
          type: string
      - name: accountId
        in: query
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupRequest'
      responses:
        '200':
          description: User group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    put:
      tags:
      - User Groups
      summary: Update user group
      operationId: updateUserGroup
      parameters:
      - name: partitionId
        in: query
        required: true
        schema:
          type: string
      - name: accountId
        in: query
        required: true
        schema:
          type: string
      - name: groupId
        in: query
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupRequest'
      responses:
        '200':
          description: User group updated
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    delete:
      tags:
      - User Groups
      summary: Delete user group
      operationId: deleteUserGroup
      parameters:
      - name: partitionId
        in: query
        required: true
        schema:
          type: string
      - name: accountId
        in: query
        required: true
        schema:
          type: string
      - name: groupId
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User group deleted
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
components:
  schemas:
    UserGroupResponse:
      type: object
      properties:
        partitionId:
          type: string
          example: partitionId123
        accountId:
          type: string
          example: accountId123
        groupId:
          type: string
          example: group1234
        groupName:
          type: string
          example: Group Name
        groupDescription:
          type: string
          example: Group Description
        userIds:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
                example: ZXR1X6geTeCpzfHm-z-WbQ
              endUserType:
                type: string
                example: BASIC_ADMIN
    PublicApiException:
      type: object
      properties:
        status:
          type: integer
        messages:
          type: array
          items:
            type: string
        data:
          type: object
          additionalProperties: true
          example:
            key: value
            key2: value2
    UserGroupRequest:
      type: object
      properties:
        partitionId:
          type: string
          example: partitionId123
        accountId:
          type: string
          example: accountId123
        groupId:
          type: string
          example: group1234
        groupName:
          type: string
          example: Group Name
        groupDescription:
          type: string
          example: Group Description
        userIds:
          type: array
          items:
            type: object
            properties:
              userId:
                type: string
                example: ZXR1X6geTeCpzfHm-z-WbQ
              endUserType:
                type: string
                example: BASIC_ADMIN
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-openapi-original.yml
- alianza-user-groups-api-openapi.yml