Aembit

Aembit Client Workload API

The Client Workload API from Aembit — 3 operation(s) for client workload.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/client-workloads Create a client workload · Create a Client Workload #
Ask an LLM
“How do I register a new client workload?”
“Can I identify a client workload by several identities when creating it?”
Tell an agent
Create client workload {name} identified by {identities}.
Add a new client workload {name} in resource set {resourceSet}.
PUT /api/v1/client-workloads Replace a client workload · Update a Client Workload #
Ask an LLM
“How do I fully update a client workload's identities?”
“Can I enforce SSO on an existing client workload?”
Tell an agent
Replace client workload {name} with identities {identities}.
Update client workload {name} to enforce SSO: {enforceSso}.
GET /api/v1/client-workloads List client workloads · Get a page of Client Workloads #
Ask an LLM
“Which client workloads are defined in my tenant?”
“Can I filter or group client workloads?”
Tell an agent
List my client workloads.
List client workloads matching {filter}.
PATCH /api/v1/client-workloads/{id} Rename, toggle or re-identify a client workload · Patch a Client Workload #
Ask an LLM
“Can I change only the identities of a client workload?”
“Is it possible to deactivate a client workload without deleting it?”
Tell an agent
Deactivate client workload {id}.
Set the identities of client workload {id} to {identities}.
GET /api/v1/client-workloads/{id} Get a client workload · Get a Client Workload #
Ask an LLM
“How is a specific client workload identified?”
“How many access policies use this client workload?”
Tell an agent
Show client workload {id}.
Get the identities configured on client workload {id}.
DELETE /api/v1/client-workloads/{id} Delete a client workload · Delete a Client Workload #
Ask an LLM
“Can I remove a client workload that is no longer deployed?”
“What is the way to delete a client workload by ID?”
Tell an agent destructive · confirm first
Delete client workload {id}.
Remove the retired client workload {id}.
GET /api/v1/client-workloads/identifiers List the supported client identifier types · Get Client Identifier List #
Ask an LLM
“What kinds of identifiers can I use to recognize a client workload?”
“Which client identifier options are available?”
Tell an agent
List the client identifier types.
Show me every supported client identifier.

Documentation

📖
Documentation
https://docs.aembit.io/dev-guide/api/cloud/
📖
APIReference
https://docs.aembit.io/dev-guide/api/cloud/api-reference-cloud/
📖
Documentation
https://docs.aembit.io/dev-guide/api/edge/
📖
APIReference
https://docs.aembit.io/dev-guide/api/edge/api-reference-edge/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aembit/refs/heads/main/openapi/aembit-client-workload-api-openapi.yml

Other Resources

🔗
SDKs
https://docs.aembit.io/dev-guide/sdk/edge/

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/aembit:aembit-client-workload-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

aembit-client-workload-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aembit Cloud Client Workload API
  version: v1
servers:
- url: https://{tenant}.aembit.io
  variables:
    tenant:
      default: tenant
      description: Aembit Tenant ID
security:
- {}
tags:
- name: Client Workload
paths:
  /api/v1/client-workloads:
    post:
      tags:
      - Client Workload
      summary: Create a Client Workload
      description: Create a Client Workload.
      operationId: post-client-workload
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadExternalDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      responses:
        '204':
          description: Created Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    put:
      tags:
      - Client Workload
      summary: Update a Client Workload
      description: Update a Client Workload.
      operationId: put-client-workload
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadExternalDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      responses:
        '200':
          description: Updated Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    get:
      tags:
      - Client Workload
      summary: Get a page of Client Workloads
      description: Get a page of Client Workloads.
      operationId: get-client-workloads
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: per-page
        in: query
        schema:
          type: integer
          format: int32
          default: 100
      - name: filter
        in: query
        schema:
          type: string
          default: ''
      - name: order
        in: query
        schema:
          type: string
          default: ''
      - name: group-by
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Page of Client Workloads
          content:
            application/json:
              schema:
                description: Page of Client Workloads
                $ref: '#/components/schemas/ClientWorkloadListDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
  /api/v1/client-workloads/{id}:
    patch:
      tags:
      - Client Workload
      summary: Patch a Client Workload
      description: Patch a Client Workload.
      operationId: patch-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: ClientWorkloadPatchDTO
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientWorkloadPatchDTO'
      responses:
        '200':
          description: Patched Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    get:
      tags:
      - Client Workload
      summary: Get a Client Workload
      description: Get a Client Workload identified by its ID.
      operationId: get-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Client Workload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientWorkloadExternalDTO'
        '204':
          description: Client Workload Not Found
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
    delete:
      tags:
      - Client Workload
      summary: Delete a Client Workload
      description: Delete a Client Workload identified by its ID.
      operationId: delete-client-workload
      parameters:
      - name: id
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Successfully deleted Client Workload
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
  /api/v1/client-workloads/identifiers:
    get:
      tags:
      - Client Workload
      summary: Get Client Identifier List
      description: Get list of client identifier objects
      operationId: get-client-identifiers
      responses:
        '200':
          description: Client Identifiers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientIdentifierExternalDTO'
        '204':
          description: Client Identifiers Not Found
        '400':
          description: Bad Request
        '401':
          description: Not Authenticated
components:
  schemas:
    GenericResponseDTO:
      type: object
      properties:
        success:
          type: boolean
          description: True if the API call was successful, False otherwise
        message:
          type:
          - 'null'
          - string
          description: Message to indicate why the API call failed
        id:
          type: integer
          description: Unique identifier of the API response
          format: int32
      additionalProperties: false
      description: DTO for a Generic API Response
    ClientIdentifierExternalDTO:
      type: object
      properties:
        name:
          type:
          - 'null'
          - string
        displayName:
          type:
          - 'null'
          - string
        environmentPath:
          type:
          - 'null'
          - string
        isSupported:
          type: boolean
      additionalProperties: false
    ClientWorkloadListDTO:
      type: object
      properties:
        page:
          type: integer
          description: Page of entities
          format: int32
        perPage:
          type: integer
          description: Number of entities requested for the current page
          format: int32
        order:
          type:
          - 'null'
          - string
          description: Ordering criteria used for the current page
        statusCode:
          type: integer
          format: int32
        recordsTotal:
          type: integer
          format: int32
        clientWorkloads:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadExternalDTO'
      additionalProperties: false
      description: Page of Client Workloads
    TagDTO:
      required:
      - key
      - value
      type: object
      properties:
        key:
          minLength: 1
          type: string
          description: Tag Key
        value:
          minLength: 1
          type: string
          description: Tag Key Value
      additionalProperties: false
      description: Aembit Entity Tag Details
    ClientWorkloadExternalDTO:
      required:
      - isActive
      - name
      - resourceSet
      type: object
      properties:
        externalId:
          type: string
          format: uuid
        name:
          maxLength: 128
          minLength: 1
          type: string
          description: Name of the Entity
        description:
          type:
          - 'null'
          - string
          description: Description of the Entity
        isActive:
          type: boolean
          description: True/False value that determines if this entity is Active or Disabled
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type:
          - 'null'
          - string
          format: date-time
        createdBy:
          type:
          - 'null'
          - string
        modifiedBy:
          type:
          - 'null'
          - string
        resourceSet:
          type: string
          description: ID of the Resource Set in which this Access Entity exists
          format: uuid
        identities:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadIdentityDTO'
        standaloneCertificateAuthority:
          type:
          - 'null'
          - string
          description: Standalone Certificate Authority associated with this Client Workload
          format: uuid
        enforceSso:
          type: boolean
          description: Whether SSO is enforced for MCP authorization
        type:
          type:
          - 'null'
          - string
        accessPolicyCount:
          type: integer
          description: Access Policies associated with this Client Workload
          format: int32
        ssoIdentityProviders:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
      additionalProperties: false
    ClientWorkloadPatchDTO:
      type: object
      properties:
        name:
          maxLength: 128
          type:
          - 'null'
          - string
          description: New Name for the identified entity
        description:
          type:
          - 'null'
          - string
          description: New Description for the identified entity
        isActive:
          type:
          - 'null'
          - boolean
          description: New Status for the identified entity
          format: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
          description: New Tags for the identified entity
        identities:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/ClientWorkloadIdentityDTO'
      additionalProperties: false
    ClientWorkloadIdentityDTO:
      required:
      - value
      type: object
      properties:
        type:
          maxLength: 255
          type:
          - 'null'
          - string
        value:
          minLength: 1
          type: string
        key:
          maxLength: 255
          type:
          - 'null'
          - string
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      description: Authorization header using the Bearer scheme.
      scheme: bearer
      bearerFormat: Reference