Aembit

Aembit Access Policy v2 API

The Access Policy v2 API from Aembit — 5 operation(s) for access policy v2.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 10

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

GET /api/v2/access-policies/{id} Get an access policy · Get the identified Access Policy #
Ask an LLM
“What workloads and providers does one access policy tie together?”
“Can I fetch a single access policy by ID with the current API?”
Tell an agent
Show access policy {id}.
Fetch the configuration of access policy {id}.
DELETE /api/v2/access-policies/{id} Delete an access policy · Delete an Access Policy #
Ask an LLM
“Can I delete an access policy I no longer use?”
“Does deleting an access policy stop the client workload's access?”
Tell an agent destructive · confirm first
Delete access policy {id}.
Remove the access policy with ID {id}.
PATCH /api/v2/access-policies/{id} Partially update an access policy · Patch an Access Policy #
Ask an LLM
“Can I attach several credential providers to an existing policy?”
“Is it possible to just disable an access policy?”
Tell an agent
Disable access policy {id}.
Set credential providers {credentialProviders} on access policy {id}.
GET /api/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId} Find the policy between two workloads · Get the identified Access Policy #
Ask an LLM
“Which access policy governs traffic from a given client workload to a server workload?”
“Can I look up a policy by its client and server workload IDs?”
Tell an agent
Get the access policy for client workload {client} and server workload {server}.
Which policy lets {client} call {server}? Look it up.
GET /api/v2/access-policies List access policies · Get a page of Access Policies #
Ask an LLM
“Which access policies are configured right now?”
“Can I search access policies with a free-text query?”
Tell an agent
List my access policies.
Search access policies for {query}.
POST /api/v2/access-policies Create an access policy · Create an Access Policy #
Ask an LLM
“How do I grant a client workload access to a server workload?”
“Can I require access conditions when creating a new policy?”
Tell an agent
Create access policy {name} connecting client {client} to server {server}.
Create a new policy {name} with access conditions {accessConditions}.
PUT /api/v2/access-policies Replace an access policy · Update an Access Policy #
Ask an LLM
“How do I overwrite an entire access policy definition?”
“Can a full policy update set multiple credential providers at once?”
Tell an agent
Replace access policy {name} with credential providers {credentialProviders}.
Fully update policy {name} in resource set {resourceSet}.
POST /api/v2/access-policies/{id}/notes Add a note to an access policy · Add a note to an Access Policy #
Ask an LLM
“How do I document a change on an access policy?”
“Can I attach a free-text note to a policy?”
Tell an agent
Add note {note} to access policy {id}.
Write {note} as a note on policy {id}.
GET /api/v2/access-policies/{id}/notes Read the notes on an access policy · Gets notes for an Access Policy #
Ask an LLM
“What notes have been left on an access policy?”
“Can I see the history of comments recorded on a policy?”
Tell an agent
Show the notes on access policy {id}.
List every note attached to policy {id}.
GET /api/v2/access-policies/{id}/credential-mappings Get an access policy's credential mappings · Gets a credential mappings of Access Policy #
Ask an LLM
“Which credentials does an access policy map to its server workload?”
“Can I see how credential providers are mapped within one policy?”
Tell an agent
Show the credential mappings for access policy {id}.
List credential mappings of policy {id}.

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-access-policy-v2-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-access-policy-v2-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-access-policy-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aembit Cloud Access Policy v2 API
  version: v1
servers:
- url: https://{tenant}.aembit.io
  variables:
    tenant:
      default: tenant
      description: Aembit Tenant ID
security:
- {}
tags:
- name: Access Policy v2
paths:
  /api/v2/access-policies/{id}:
    get:
      tags:
      - Access Policy v2
      summary: Get the identified Access Policy
      description: Get the Access Policy identified by its ID.
      operationId: get-access-policy-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Access Policy
          content:
            application/json:
              schema:
                description: Individual Access Policy
                $ref: '#/components/schemas/GetPolicyDTO'
        '204':
          description: Access Policy 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:
      - Access Policy v2
      summary: Delete an Access Policy
      description: Delete an Access Policy.
      operationId: delete-access-policy-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Deleted the Access Policy
        '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'
    patch:
      tags:
      - Access Policy v2
      summary: Patch an Access Policy
      description: Patch an Access Policy.
      operationId: patch-access-policy-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: PatchPolicyV2DTO
        content:
          application/json:
            schema:
              description: Patch request for an Access Policy
              $ref: '#/components/schemas/PatchPolicyV2DTO'
      responses:
        '200':
          description: Patched Access Policy
          content:
            application/json:
              schema:
                description: Create/Update Access Policy
                $ref: '#/components/schemas/CreatePolicyDTO'
        '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/v2/access-policies/getByWorkloadIds/{clientWorkloadId}/{serverWorkloadId}:
    get:
      tags:
      - Access Policy v2
      summary: Get the identified Access Policy
      description: Get the Access Policy identified by a Client and Server Workload.
      operationId: get-access-policy-by-workloads-v2
      parameters:
      - name: clientWorkloadId
        in: path
        description: ID of Client Workload
        required: true
        schema:
          type: string
          format: uuid
      - name: serverWorkloadId
        in: path
        description: ID of Server Workload
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Access Policy
          content:
            application/json:
              schema:
                description: Individual Access Policy
                $ref: '#/components/schemas/GetPolicyDTO'
        '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/v2/access-policies:
    get:
      tags:
      - Access Policy v2
      summary: Get a page of Access Policies
      description: Retrieve a page of Access Policies.
      operationId: get-access-policies-v2
      parameters:
      - 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
        description: Filter returned access policies using either a string or a key:value combination
        schema:
          type: string
          default: ''
      - name: order
        in: query
        schema:
          type: string
          default: ModifiedAt desc
      - name: group-by
        in: query
        schema:
          type: string
          default: ''
      - name: query
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Page of Access Policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPolicyDTOListDTO'
        '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'
    post:
      tags:
      - Access Policy v2
      summary: Create an Access Policy
      description: Create an Access Policy.
      operationId: post-access-policy-v2
      requestBody:
        description: CreatePolicyDTO
        content:
          application/json:
            schema:
              description: Create/Update Access Policy
              $ref: '#/components/schemas/CreatePolicyDTO'
      responses:
        '200':
          description: Created Access Policy
          content:
            application/json:
              schema:
                description: Create/Update Access Policy
                $ref: '#/components/schemas/CreatePolicyDTO'
        '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:
      - Access Policy v2
      summary: Update an Access Policy
      description: Update an Access Policy.
      operationId: put-access-policy-v2
      requestBody:
        description: CreatePolicyDTO
        content:
          application/json:
            schema:
              description: Create/Update Access Policy
              $ref: '#/components/schemas/CreatePolicyDTO'
      responses:
        '200':
          description: Updated Access Policy
          content:
            application/json:
              schema:
                description: Create/Update Access Policy
                $ref: '#/components/schemas/CreatePolicyDTO'
        '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/v2/access-policies/{id}/notes:
    post:
      tags:
      - Access Policy v2
      summary: Add a note to an Access Policy
      description: Add a note to an Access Policy.
      operationId: post-access-policy-note-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: PolicyNoteDTO
        content:
          application/json:
            schema:
              description: Individual Note created for an Access Policy
              $ref: '#/components/schemas/PolicyNoteDTO'
      responses:
        '201':
          description: Note added to an Access Policy
        '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:
      - Access Policy v2
      summary: Gets notes for an Access Policy
      description: Retrieves note information for an Access Policy.
      operationId: get-access-policy-notes-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Page of Access Policy Notes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyNoteDTOListDTO'
        '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/v2/access-policies/{id}/credential-mappings:
    get:
      tags:
      - Access Policy v2
      summary: Gets a credential mappings of Access Policy
      description: Retrieves credential mappings of Access Policy.
      operationId: get-access-policy-credential-mappings-v2
      parameters:
      - name: id
        in: path
        description: ID of Access Policy
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Page of Credential Mappings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicyNoteDTOListDTO'
        '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'
components:
  schemas:
    PolicyNoteDTO:
      required:
      - note
      type: object
      properties:
        note:
          maxLength: 1024
          minLength: 1
          type: string
          description: Note added to an Access Policy by a User
        createdAt:
          type: string
          description: Timestamp the Note was created
          format: date-time
        createdBy:
          type:
          - 'null'
          - string
          description: Email address of the User who created the Access Policy Note
      additionalProperties: false
      description: Individual Note created for an Access Policy
    PatchPolicyV2DTO:
      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
        clientWorkload:
          type: string
          description: Client Workload associated with this Access Policy
          format: uuid
        serverWorkload:
          type: string
          description: Server Workload associated with this Access Policy
          format: uuid
        credentialProviders:
          type:
          - 'null'
          - array
          items:
            description: Access Policy Credential Mappings
            $ref: '#/components/schemas/PolicyCredentialMappingDTO'
          description: Credential Providers associated with this Access Policy
        trustProviders:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Trust Providers associated with this Access Policy
        accessConditions:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Access Conditions associated with this Access Policy
        contentSecurity:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Content Security associated with this Access Policy
      additionalProperties: false
      description: Patch request for an Access Policy
    EntityMetaDTO:
      type: object
      properties:
        externalId:
          type: string
          format: uuid
        name:
          type:
          - 'null'
          - string
        isActive:
          type: boolean
        tags:
          type:
          - 'null'
          - array
          items:
            description: Aembit Entity Tag Details
            $ref: '#/components/schemas/TagDTO'
      additionalProperties: false
    PolicyNoteDTOListDTO:
      type: object
      properties:
        page:
          type: integer
          description: Current page number 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
          description: HTTP StatusCode for the current result
          format: int32
        recordsTotal:
          type: integer
          description: Total number of entities available
          format: int32
        entities:
          type:
          - 'null'
          - array
          items:
            description: Individual Note created for an Access Policy
            $ref: '#/components/schemas/PolicyNoteDTO'
          description: Page of entities for this request
      additionalProperties: false
    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
    CreatePolicyDTO:
      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
        credentialProviders:
          type:
          - 'null'
          - array
          items:
            description: Access Policy Credential Mappings
            $ref: '#/components/schemas/PolicyCredentialMappingDTO'
          description: Credential Providers associated with this Access Policy
        trustProviders:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Trust Providers associated with this Access Policy
        accessConditions:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Access Conditions associated with this Access Policy
        contentSecurity:
          type:
          - 'null'
          - array
          items:
            type: string
            format: uuid
          description: Content Security associated with this Access Policy
        clientWorkload:
          type: string
          description: Client Workload associated with this Access Policy
          format: uuid
        serverWorkload:
          type: string
          description: Server Workload associated with this Access Policy
          format: uuid
      additionalProperties: false
      description: Create/Update Access Policy
    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
    PolicyCredentialMappingDTO:
      required:
      - credentialProviderId
      - mappingType
      type: object
      properties:
        credentialProviderId:
          type: string
          description: CredentialProviderId
          format: uuid
        mappingType:
          description: Mapping Type
          $ref: '#/components/schemas/PolicyCredentialProviderMappingTypes'
        accessKeyId:
          maxLength: 256
          pattern: ^[A-Z0-9]*$
          type:
          - 'null'
          - string
          description: AWS Access Key Id
        accountName:
          maxLength: 256
          pattern: ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$
          type:
          - 'null'
          - string
          description: Snowflake Username
        headerName:
          maxLength: 256
          pattern: ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$
          type:
          - 'null'
          - string
          description: Header Name
        headerValue:
          maxLength: 256
          pattern: ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$
          type:
          - 'null'
          - string
          description: Header Value
        httpbodyFieldPath:
          maxLength: 256
          pattern: ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$
          type:
          - 'null'
          - string
          description: HttpBody Field Path
        httpbodyFieldValue:
          maxLength: 256
          pattern: ^[\p{L}a-zA-Z0-9][\p{L}a-zA-Z0-9._-]*$
          type:
          - 'null'
          - string
          description: HttpBody Field Value
      additionalProperties: false
      description: Access Policy Credential Mappings
    PolicyCredentialProviderMappingTypes:
      enum:
      - None
      - AccountName
      - HttpHeader
      - HttpBody
      - AccessKeyId
      type: string
    GetPolicyDTOListDTO:
      type: object
      properties:
        page:
          type: integer
          description: Current page number 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
          description: HTTP StatusCode for the current result
          format: int32
        recordsTotal:
          type: integer
          description: Total number of entities available
          format: int32
        entities:
          type:
          - 'null'
          - array
          items:
            description: Individual Access Policy
            $ref: '#/components/schemas/GetPolicyDTO'
          description: Page of entities for this request
      additionalProperties: false
    GetPolicyDTO:
      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
        clientWorkload:
          description: Client Workload associated with this Access Policy
          $ref: '#/components/schemas/EntityMetaDTO'
        serverWorkload:
          description: Server Workload associated with this Access Policy
          $ref: '#/components/schemas/EntityMetaDTO'
        trustProviders:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/EntityMetaDTO'
          description: Trust Providers associated with this Access Policy
        credentialProviders:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/EntityMetaDTO'
          description: Credential Providers associated with this Access Policy
        accessConditions:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/EntityMetaDTO'
          description: Access Conditions associated with this Access Policy
        contentSecurity:
          type:
          - 'null'
          - array
          items:
            $ref: '#/components/schemas/EntityMetaDTO'
          description: Content Security associated with this Access Policy
      additionalProperties: false
      description: Individual Access Policy
  securitySchemes:
    bearerAuth:
      type: http
      description: Authorization header using the Bearer scheme.
      scheme: bearer
      bearerFormat: Reference