Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Authentication Providers API

10 actions 10 updates phrasing extends openapi/canvas-authentication-providers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Canvas's API. It is a proposal applied on top of the contract, not a document Canvas publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v1/accounts/{account_id}/authentication_providers'].get
$.paths['/v1/accounts/{account_id}/authentication_providers'].post
$.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].get
$.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].put
$.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].delete
$.paths['/v1/accounts/{account_id}/authentication_providers/{id}/restore'].put
$.paths['/v1/accounts/{account_id}/sso_settings'].get
$.paths['/v1/accounts/{account_id}/sso_settings'].put
$.paths['/v1/accounts/{account_id}/authentication_providers/force_password_reset'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Canvas LMS REST Authentication Providers API
  version: 1.0.0
extends: openapi/canvas-authentication-providers-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: 9
- target: $.paths['/v1/accounts/{account_id}/authentication_providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's login providers
      effect: read
      questions:
      - Which login methods are configured for a Canvas account?
      - How do I see all the SSO providers set up on an account?
      instructions:
      - text: List the authentication providers for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show every login provider configured on account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a login provider to an account
      effect: write
      questions:
      - How do I add SAML single sign-on to an account?
      - Which authentication services can I add, such as LDAP, CAS or OpenID Connect?
      instructions:
      - text: Add a new authentication provider to account {account_id}.
        slots:
          account_id: path.account_id
      - text: Set up an SSO login provider on account {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one login provider's configuration
      effect: read
      questions:
      - How do I view the settings of one specific authentication provider?
      - What configuration does a single SSO provider on an account have?
      instructions:
      - text: Get authentication provider {id} on account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Show the configuration of login provider {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a login provider's settings
      effect: write
      questions:
      - How do I change the settings of an existing SSO provider?
      - Can I switch an existing provider to a different authentication type?
      instructions:
      - text: Update authentication provider {id} on account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Change the configuration of login provider {id} in account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a login provider
      effect: destructive
      questions:
      - How do I remove an SSO provider from an account?
      - Can a deleted authentication provider be brought back later?
      instructions:
      - text: Delete authentication provider {id} from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Remove login provider {id} from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers/{id}/restore'].put
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted login provider
      effect: write
      questions:
      - How do I undo the deletion of an authentication provider?
      - Who is allowed to restore a deleted SSO provider?
      instructions:
      - text: Restore deleted authentication provider {id} on account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      - text: Reactivate login provider {id} that was deleted from account {account_id}.
        slots:
          id: path.id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/sso_settings'].get
  update:
    x-apievangelist-phrasing:
      intent: View an account's SSO settings
      effect: read
      questions:
      - What account-level single sign-on settings are currently in effect?
      - How do I check an account's login page and SSO configuration options?
      instructions:
      - text: Show the SSO settings for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Get account {account_id}'s current auth settings.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/sso_settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an account's SSO settings
      effect: write
      questions:
      - How do I change account-level settings for a mixed SSO setup?
      - Can I update the account's single sign-on settings in one request?
      instructions:
      - text: Update the SSO settings for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Change account {account_id}'s auth settings.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/{account_id}/authentication_providers/force_password_reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Force all users to reset passwords
      effect: write
      questions:
      - How do I make every Canvas-login user in an account change their password?
      - Does forcing a password reset affect SSO users?
      instructions:
      - text: Force a password reset for all Canvas logins on account {account_id}.
        slots:
          account_id: path.account_id
      - text: Require everyone in account {account_id} to change their password on next login.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'