Aembit

Aembit Credential Provider (Deprecated) API

The Credential Provider (Deprecated) API from Aembit — 4 operation(s) for credential provider (deprecated).

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 8

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/v1/credential-providers/{id} Get a credential provider (v1) · Get a Credential Provider #
Ask an LLM
“What type and lifetime does a credential provider have in the v1 API?”
“Can I fetch one credential provider by ID using the deprecated endpoint?”
Tell an agent
Show v1 credential provider {id}.
Get credential provider {id} from the old v1 API.
DELETE /api/v1/credential-providers/{id} Delete a credential provider (v1) · Delete a Credential Provider #
Ask an LLM
“Can I delete a credential provider through the v1 API?”
“What breaks if I delete a credential provider used by policies?”
Tell an agent destructive · confirm first
Delete v1 credential provider {id}.
Remove credential provider {id} using the deprecated endpoint.
PATCH /api/v1/credential-providers/{id} Partially update a credential provider (v1) · Patch a Credential Provider #
Ask an LLM
“Can I change a credential provider's provider details without a full update in v1?”
“Is it possible to deactivate a credential provider via v1?”
Tell an agent
Deactivate v1 credential provider {id}.
Set the provider details of credential provider {id} to {details}.
GET /api/v1/credential-providers/{id}/authorize Get a credential provider's authorization URL (v1) · Get a Credential Provider Authorization URL #
Ask an LLM
“Where do I send a user to authorize an OAuth credential provider in v1?”
“How do I get the consent URL for a credential provider using the old API?”
Tell an agent
Get the authorization URL for v1 credential provider {id}.
Give me the v1 consent link for credential provider {id}.
GET /api/v1/credential-providers List credential providers (v1) · Get a page of Credential Providers #
Ask an LLM
“Which credential providers exist according to the v1 API?”
“Can I filter credential providers in the deprecated list?”
Tell an agent
List credential providers with the v1 API.
List v1 credential providers matching {filter}.
POST /api/v1/credential-providers Create a credential provider (v1) · Create a Credential Provider #
Ask an LLM
“How do I create a credential provider with the deprecated API?”
“Can I set the credential type and lifetime when creating a v1 credential provider?”
Tell an agent
Create v1 credential provider {name} of type {type}.
Add a credential provider {name} with details {details} via v1.
PUT /api/v1/credential-providers Replace a credential provider (v1) · Update a Credential Provider #
Ask an LLM
“How do I fully update a credential provider with the v1 API?”
“Can I change a credential's lifetime with a full v1 update?”
Tell an agent
Replace v1 credential provider {name} of type {type}.
Update credential provider {name} to a lifetime of {seconds} seconds.
GET /api/v1/credential-providers/{id}/verification Verify a credential provider (v1) · Verify the Credential Provider #
Ask an LLM
“Will this credential provider actually return a credential, checked through v1?”
“How do I test a credential provider's configuration using the old API?”
Tell an agent
Verify v1 credential provider {id}.
Test whether credential provider {id} returns a credential using v1.

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-credential-provider-deprecated-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-credential-provider-deprecated-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-credential-provider-deprecated-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aembit Cloud Credential Provider (Deprecated) API
  version: v1
servers:
- url: https://{tenant}.aembit.io
  variables:
    tenant:
      default: tenant
      description: Aembit Tenant ID
security:
- {}
tags:
- name: Credential Provider (Deprecated)
paths:
  /api/v1/credential-providers/{id}:
    get:
      tags:
      - Credential Provider (Deprecated)
      summary: Get a Credential Provider
      description: Get a Credential Provider identified by its ID.
      operationId: get-credential-provider
      parameters:
      - name: id
        in: path
        description: ID of Credential Provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Credential Provider
          content:
            application/json:
              schema:
                description: Individual Credential Provider
                $ref: '#/components/schemas/CredentialProviderUIDTO'
        '204':
          description: Credential Provider 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:
      - Credential Provider (Deprecated)
      summary: Delete a Credential Provider
      description: Delete a Credential Provider identified by its ID.
      operationId: delete-credential-provider
      parameters:
      - name: id
        in: path
        description: ID of Credential Provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Deleted Credential Provider
        '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'
    patch:
      tags:
      - Credential Provider (Deprecated)
      summary: Patch a Credential Provider
      description: Patch a Credential Provider.
      operationId: patch-credential-provider
      parameters:
      - name: id
        in: path
        description: ID of Credential Provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: CredentialProviderPatchDTO
        content:
          application/json:
            schema:
              description: Patch request for an individual Credential Provider
              $ref: '#/components/schemas/CredentialProviderPatchDTO'
      responses:
        '201':
          description: Patched Credential Provider
          content:
            application/json:
              schema:
                description: Individual Credential Provider
                $ref: '#/components/schemas/CredentialProviderUIDTO'
        '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/credential-providers/{id}/authorize:
    get:
      tags:
      - Credential Provider (Deprecated)
      summary: Get a Credential Provider Authorization URL
      description: Get a Credential Provider Authorization URL identified by the Credential Provider ID.
      operationId: get-credential-provider-authorization
      parameters:
      - name: id
        in: path
        description: ID of Credential Provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '302':
          description: Redirects to the Credential Provider Authorization URL
        '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/credential-providers:
    get:
      tags:
      - Credential Provider (Deprecated)
      summary: Get a page of Credential Providers
      description: Get a page of Credential Providers.
      operationId: get-credential-providers
      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 Credential Providers
          content:
            application/json:
              schema:
                description: Page of Credential Providers
                $ref: '#/components/schemas/CredentialProviderUIDTOCredentialProviderListDTO'
        '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:
      - Credential Provider (Deprecated)
      summary: Create a Credential Provider
      description: Create a Credential Provider.
      operationId: post-credential-provider
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: CredentialProviderDTO
        content:
          application/json:
            schema:
              description: Individual Credential Provider
              $ref: '#/components/schemas/CredentialProviderDTO'
      responses:
        '201':
          description: Created Credential Provider
          content:
            application/json:
              schema:
                description: Individual Credential Provider
                $ref: '#/components/schemas/CredentialProviderUIDTO'
        '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:
      - Credential Provider (Deprecated)
      summary: Update a Credential Provider
      description: Update a Credential Provider.
      operationId: put-credential-provider
      parameters:
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      requestBody:
        description: CredentialProviderDTO
        content:
          application/json:
            schema:
              description: Individual Credential Provider
              $ref: '#/components/schemas/CredentialProviderDTO'
      responses:
        '201':
          description: Updated Credential Provider
          content:
            application/json:
              schema:
                description: Individual Credential Provider
                $ref: '#/components/schemas/CredentialProviderUIDTO'
        '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/credential-providers/{id}/verification:
    get:
      tags:
      - Credential Provider (Deprecated)
      summary: Verify the Credential Provider
      description: Verify the Credential Provider will successfully return a credential.
      operationId: get-credential-provider-verification
      parameters:
      - name: id
        in: path
        description: ID of Credential Provider
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Aembit-ResourceSet
        in: header
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Details on the verification of a Credential Provider
          content:
            application/json:
              schema:
                description: DTO for a Generic API Response
                $ref: '#/components/schemas/GenericResponseDTO'
        '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:
    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
    CredentialProviderDTO:
      required:
      - isActive
      - name
      - resourceSet
      - type
      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
        type:
          minLength: 1
          type: string
          description: Credential Provider Type (e.g. oauth-client-credential, username-password, etc.)
        roleId:
          type:
          - 'null'
          - string
          description: Credential Provider Role for use with Aembit Access Token type Credential Providers
          format: uuid
        lifetimeTimeSpanSeconds:
          type: integer
          description: The Lifetime of a Credential Provider's credential value
          format: int32
        lifetimeExpiration:
          type:
          - 'null'
          - string
          description: The expiration timestamp for a Credential Provider's credential value
          format: date-time
        providerDetailJSON:
          type:
          - 'null'
          - string
          description: JSON representation of the Credential Provider configuration details
        accessPolicyCount:
          type: integer
          description: Access Policies associated with this Credential Provider
          format: int32
      additionalProperties: false
      description: Individual Credential Provider
    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
    CredentialProviderUIDTO:
      required:
      - isActive
      - name
      - resourceSet
      - type
      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
        type:
          minLength: 1
          type: string
          description: Credential Provider Type (e.g. oauth-client-credential, username-password, etc.)
        roleId:
          type:
          - 'null'
          - string
          description: Credential Provider Role for use with Aembit Access Token type Credential Providers
          format: uuid
        lifetimeTimeSpanSeconds:
          type: integer
          description: The Lifetime of a Credential Provider's credential value
          format: int32
        lifetimeExpiration:
          type:
          - 'null'
          - string
          description: The expiration timestamp for a Credential Provider's credential value
          format: date-time
        providerDetailJSON:
          type:
          - 'null'
          - string
          description: JSON representation of the Credential Provider configuration details
        accessPolicyCount:
          type: integer
          description: Access Policies associated with this Credential Provider
          format: int32
      additionalProperties: false
      description: Individual Credential Provider
    CredentialProviderPatchDTO:
      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
        providerDetailJSON:
          type:
          - 'null'
          - string
          description: JSON representation of the Credential Provider configuration details
        type:
          type:
          - 'null'
          - string
          description: Credential Provider Type (e.g. oauth-client-credential, username-password, etc.)
      additionalProperties: false
      description: Patch request for an individual Credential Provider
    CredentialProviderUIDTOCredentialProviderListDTO:
      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
          description: HTTP Status Code of the response
          format: int32
        recordsTotal:
          type: integer
          description: Total number of Credential Providers
          format: int32
        credentialProviders:
          type:
          - 'null'
          - array
          items:
            description: Individual Credential Provider
            $ref: '#/components/schemas/CredentialProviderUIDTO'
          description: Page of Credential Providers
      additionalProperties: false
      description: Page of Credential Providers
  securitySchemes:
    bearerAuth:
      type: http
      description: Authorization header using the Bearer scheme.
      scheme: bearer
      bearerFormat: Reference