Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.SignIns Organization.certificate Based Auth…

6 actions 6 updates phrasing extends openapi/azure-ad-organization-certificatebasedauthconfiguration-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/organization/{organization-id}/certificateBasedAuthConfiguration'].get

$.paths['/organization/{organization-id}/certificateBasedAuthConfiguration'].post

$.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}'].get

$.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}'].delete

$.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/$count'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Organization.certificate Based Auth…
  version: 1.0.0
extends: openapi/azure-ad-organization-certificatebasedauthconfiguration-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/organization/{organization-id}/certificateBasedAuthConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: List certificate-based auth configurations
      effect: read
      questions:
      - Which certificate authorities are trusted for certificate-based sign-in in my organization?
      - Can I list the certificate-based authentication configurations on a tenant?
      instructions:
      - text: List the certificate-based auth configurations for organization {org_id}.
        slots:
          org_id: path.organization-id
      - text: Show all trusted CA configurations for smart card sign-in in {org_id}.
        slots:
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}/certificateBasedAuthConfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a certificate-based auth configuration
      effect: write
      questions:
      - How do I upload my certificate authorities to enable certificate-based authentication in Entra ID?
      - What does a new certificate-based auth configuration need in its request?
      instructions:
      - text: Create a certificate-based auth configuration for organization {org_id} with authorities {authorities}.
        slots:
          org_id: path.organization-id
          authorities: requestBody.certificateAuthorities
      - text: 'Set up certificate sign-in trust on {org_id} using these root and intermediate CAs: {authorities}.'
        slots:
          org_id: path.organization-id
          authorities: requestBody.certificateAuthorities
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one certificate-based auth configuration
      effect: read
      questions:
      - What certificate authorities are in a specific certificate-based auth configuration?
      - Can I read one certificate-based authentication configuration by ID?
      instructions:
      - text: Get certificate-based auth configuration {config_id} for organization {org_id}.
        slots:
          config_id: path.certificateBasedAuthConfiguration-id
          org_id: path.organization-id
      - text: Show the CA list in configuration {config_id} on {org_id}.
        slots:
          config_id: path.certificateBasedAuthConfiguration-id
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/{certificateBasedAuthConfiguration-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a certificate-based auth configuration
      effect: destructive
      questions:
      - How do I remove the trusted CA configuration for certificate sign-in?
      - What happens to smart card sign-in if I delete the certificate-based auth configuration?
      instructions:
      - text: Delete certificate-based auth configuration {config_id} from organization {org_id}.
        slots:
          config_id: path.certificateBasedAuthConfiguration-id
          org_id: path.organization-id
      - text: Remove CA trust configuration {config_id} on {org_id}.
        slots:
          config_id: path.certificateBasedAuthConfiguration-id
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}/certificateBasedAuthConfiguration/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count certificate-based auth configurations
      effect: read
      questions:
      - How many certificate-based auth configurations does my organization have?
      - Is certificate-based authentication configured on this tenant at all?
      instructions:
      - text: Count the certificate-based auth configurations for organization {org_id}.
        slots:
          org_id: path.organization-id
      - text: Return the number of CA trust configurations on {org_id}.
        slots:
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'