Alianza

Alianza Cymbus User Product API

The Cymbus User Product API from Alianza — 7 operation(s) for cymbus user product.

GitHub OpenAPI

Operations 7

GET /v2/cymbus/partition-group/{partitionId} Retrieve Cymbus group #
PUT /v2/cymbus/partition-group Update Cymbus group #
PUT /v2/cymbus/account-group Update Cymbus account group #
GET /v2/cymbus/account-group/{accountid} Retrieve Cymbus account group #
POST /v2/cymbus/account-group/prevalidate Prevalidate Cymbus account name #
GET /v2/cymbus/{userid}/sipcredentials Retrieve sip credentials for Cymbus user #
PUT /v2/cymbus/{userid}/sipcredentials/change Change sip password for Cymbus user #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/alianza/openapi/alianza-cymbus-user-product-api-openapi.yml

Other Resources

🔗
Swagger
https://artifacts.apis.io/alianza/openapi/_original/alianza-apidocs-swagger2-original.json
🔗
ToolCrosswalk
https://artifacts.apis.io/alianza/mcp/alianza-tool-crosswalk.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/alianza:alianza-cymbus-user-product-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

alianza-cymbus-user-product-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Alianza Cymbus User Product API
  version: '2'
  description: 'Operations tagged Cymbus User Product across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.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
tags:
- name: Cymbus User Product
paths:
  /v2/cymbus/partition-group/{partitionId}:
    get:
      tags:
      - Cymbus User Product
      summary: Retrieve Cymbus group
      description: Use to retrieve the Cymbus group associated to a partition
      operationId: retrieveCymbusPartitionGroup
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
          content:
            application/json:
              schema:
                originalRef: CymbusPartitionGroup
                $ref: '#/components/schemas/CymbusPartitionGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
          schema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
  /v2/cymbus/partition-group:
    put:
      tags:
      - Cymbus User Product
      summary: Update Cymbus group
      description: Use to update specific Cymbus group (only support email and name
      operationId: updateCymbusPartitionGroup
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
          content:
            application/json:
              schema:
                originalRef: CymbusPartitionGroup
                $ref: '#/components/schemas/CymbusPartitionGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
          schema:
            originalRef: CymbusPartitionGroup
            $ref: '#/components/schemas/CymbusPartitionGroup'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: CymbusPartitionGroup
              $ref: '#/components/schemas/CymbusPartitionGroup'
        description: cymbus partition group object
        required: true
  /v2/cymbus/account-group:
    put:
      tags:
      - Cymbus User Product
      summary: Update Cymbus account group
      description: Use to update Cymbus account group
      operationId: updateCymbusAccountGroup
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
          content:
            application/json:
              schema:
                originalRef: CymbusAccountGroup
                $ref: '#/components/schemas/CymbusAccountGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
          schema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: CymbusAccountGroup
              $ref: '#/components/schemas/CymbusAccountGroup'
        description: Stretto Device Line object
        required: true
  /v2/cymbus/account-group/{accountid}:
    get:
      tags:
      - Cymbus User Product
      summary: Retrieve Cymbus account group
      description: Use to retrieve the Cymbus group associated to an account
      operationId: retrieveStrettoDeviceLinesGroup
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: accountid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
          content:
            application/json:
              schema:
                originalRef: CymbusAccountGroup
                $ref: '#/components/schemas/CymbusAccountGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
          schema:
            originalRef: CymbusAccountGroup
            $ref: '#/components/schemas/CymbusAccountGroup'
  /v2/cymbus/account-group/prevalidate:
    post:
      tags:
      - Cymbus User Product
      summary: Prevalidate Cymbus account name
      description: Use to verify that the chosen name is available
      operationId: prevalidateCymbusGroupName
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: groupName
        in: query
        required: false
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
  /v2/cymbus/{userid}/sipcredentials:
    get:
      tags:
      - Cymbus User Product
      summary: Retrieve sip credentials for Cymbus user
      description: Use to retrieve sip creds for both lines associated to an account
      operationId: retrieveSipCredentialsForCymbusUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: userid
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
          content:
            application/json:
              schema:
                originalRef: SipCredentialData
                $ref: '#/components/schemas/SipCredentialData'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
          schema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
  /v2/cymbus/{userid}/sipcredentials/change:
    put:
      tags:
      - Cymbus User Product
      summary: Change sip password for Cymbus user
      description: Use to change sip password for both Cymbus user lines
      operationId: changeSipCredentialsForCymbusUser
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: userid
        in: path
        description: ID of end-user
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
          content:
            application/json:
              schema:
                originalRef: SipCredentialData
                $ref: '#/components/schemas/SipCredentialData'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
          schema:
            originalRef: SipCredentialData
            $ref: '#/components/schemas/SipCredentialData'
components:
  schemas:
    CymbusPartitionGroup:
      type: object
      properties:
        partitionId:
          type: string
        supportEmail:
          type: string
        productName:
          type: string
        voicemailStarCode:
          type: string
        proxyHost:
          type: string
        groupName:
          type: string
    SipCredentialData:
      type: object
      properties:
        sipUsernameLine1:
          type: string
        sipUsernameLine2:
          type: string
        sipPassword:
          type: string
    CymbusAccountGroup:
      type: object
      properties:
        id:
          type: string
        accountName:
          type: string
        groupName:
          type: string
        partitionId:
          type: string
    PublicApiException:
      type: object
      properties:
        status:
          type: integer
        messages:
          type: array
          items:
            type: string
        data:
          type: object
          additionalProperties: true
          example:
            key: value
            key2: value2
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-apidocs-swagger2-original.json
- alianza-openapi-original.yml
x-provenance:
  method: harvested
  publisher: Alianza
  source: https://developer.alianza.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)