Aha.io Identity providers API

The Identity providers API from Aha.io — 2 operation(s) for identity providers.

OpenAPI Specification

aha-identity-providers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Aha! Account backups Identity providers API
  version: 1.0.0
  description: Complete API documentation for Aha! generated from actual test responses
  contact:
    name: Aha! Support
    url: https://www.aha.io/support
servers:
- url: https://{account-domain}.aha.io/api/v1
  description: Aha! API Server
  variables:
    account-domain:
      description: Your Aha! account domain
      default: company
security:
- OAuth2: []
- ApiKeyAuth: []
- CookieAuth: []
tags:
- name: Identity providers
paths:
  /api/v1/identity_providers:
    get:
      summary: List active identity providers that can be used for SSO
      description: null
      tags:
      - Identity providers
      parameters: []
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/IdentityprovidersGetResponse'
              example:
                identity_providers:
                - id: '483954339'
                  enabled: true
                  name: notebook
                  sso_endpoint: https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
  /api/v1/identity_providers/{id}:
    get:
      summary: Get a specific identity provider
      description: null
      tags:
      - Identity providers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Id identifier
      responses:
        '200':
          description: Successful operation
          headers:
            Content-Type:
              description: application/json; charset=utf-8
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/IdentityprovidersGetResponse'
              example:
                identity_provider:
                  id: '483954339'
                  enabled: true
                  name: notebook
                  sso_endpoint: https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml
                  created_at: '2019-01-01T00:00:00.000Z'
                  updated_at: '2019-01-01T00:00:00.000Z'
      security:
      - OAuth2: []
      - ApiKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    IdentityprovidersGetResponse:
      type: object
      properties:
        identity_provider:
          type: object
          properties:
            id:
              type: string
              example: '483954339'
            enabled:
              type: boolean
              example: true
            name:
              type: string
              example: notebook
            sso_endpoint:
              type: string
              example: https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml
            created_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
            updated_at:
              type: string
              example: '2019-01-01T00:00:00.000Z'
          example:
            id: '483954339'
            enabled: true
            name: notebook
            sso_endpoint: https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml
            created_at: '2019-01-01T00:00:00.000Z'
            updated_at: '2019-01-01T00:00:00.000Z'
      example:
        identity_provider:
          id: '483954339'
          enabled: true
          name: notebook
          sso_endpoint: https://dev-344119.oktapreview.com/app/nonodev344119_devapp_1/exkakanw6tt4fzIa20h7/sso/saml
          created_at: '2019-01-01T00:00:00.000Z'
          updated_at: '2019-01-01T00:00:00.000Z'
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth2 authentication with bearer tokens
      flows:
        authorizationCode:
          authorizationUrl: https://{account-domain}.aha.io/oauth/authorize
          tokenUrl: https://{account-domain}.aha.io/oauth/token
          scopes: {}
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: API key authentication using Bearer token in Authorization header. Generate API keys at https://secure.aha.io/settings/api_keys
    CookieAuth:
      type: apiKey
      in: cookie
      name: session
      description: Cookie-based authentication for web browser integration