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/mammoth-io:mammoth-io-oauth-clients-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

openapi: 3.2.0
info:
  title: Mammoth Io OAuth Clients API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged OAuth Clients across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: OAuth Clients
paths:
  /workspaces/{workspace_id}/oauth-clients:
    get:
      tags:
      - OAuth Clients
      summary: List a workspace's registered OAuth clients
      operationId: ListOauthClients
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      responses:
        '200':
          description: List of OAuth clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientsList'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    post:
      tags:
      - OAuth Clients
      summary: Register a third-party OAuth client
      description: 'Registers an OAuth client (authorization-code + PKCE only) for a workspace: confidential by default, or public with token_endpoint_auth_method none. The client secret is returned once, and a public client has none.'
      operationId: CreateOauthClient
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OAuthClientCreate'
        required: true
      responses:
        '201':
          description: Successful create
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuthClientCreateResponse'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    OAuthClientSchema:
      properties:
        id:
          type: integer
          exclusiveMinimum: 0.0
          examples:
          - value: 1
        client_id:
          type: string
          description: Public OAuth client_id
          examples:
          - value: oc_a1b2c3d4e5f6
        name:
          type: string
          description: Name of the OAuth client
          examples:
          - value: Example Integration
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of the OAuth client
          examples:
          - value: Third-party integration example
        redirect_uris:
          items:
            type: string
          type: array
          description: Allowed OAuth redirect URIs for this client
          examples:
          - value:
            - https://example-integration.com/oauth/callback
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          description: Workspace ID the OAuth client is registered under
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of the user who registered the OAuth client
        logo_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's logo, shown on the consent screen
        tos_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's terms of service
        privacy_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's privacy policy
        token_endpoint_auth_method:
          type: string
          description: 'client_secret_basic (confidential, default) or none (a public client: PKCE only, no secret, loopback redirect URIs allowed)'
        created_at:
          type: string
          format: date-time
          description: When the OAuth client was registered
          examples:
          - value: '2021-09-28T11:30:00.000Z'
      type: object
      required:
      - client_id
      - created_at
      - id
      - name
      - redirect_uris
      - token_endpoint_auth_method
      - user_id
      - workspace_id
      title: OAuthClientSchema
    OAuthClientsList:
      properties:
        result:
          items:
            $ref: '#/components/schemas/OAuthClientSchema'
          type: array
      type: object
      required:
      - result
      title: OAuthClientsList
    OAuthClientCreate:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          description: Name of the OAuth client
          examples:
          - value: Example Integration
        description:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: Description of the OAuth client
          examples:
          - value: Third-party integration example
        redirect_uris:
          items:
            type: string
          type: array
          maxItems: 10
          minItems: 1
          description: Allowed OAuth redirect URIs for this client
          examples:
          - value:
            - https://example-integration.com/oauth/callback
        logo_url:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: https:// URL of the client's logo, shown on the consent screen
        tos_url:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: https:// URL of the client's terms of service
        privacy_url:
          oneOf:
          - type: string
          - type: 'null'
          maxLength: 500
          description: https:// URL of the client's privacy policy
        token_endpoint_auth_method:
          type: string
          enum:
          - client_secret_basic
          - none
          description: 'client_secret_basic (confidential, default) or none (a public client: PKCE only, no secret, loopback redirect URIs allowed)'
          default: client_secret_basic
      type: object
      required:
      - name
      - redirect_uris
      title: OAuthClientCreate
      description: Details of the OAuth client to register
      examples:
      - name: Example Integration
        description: Third-party integration example
        redirect_uris:
        - https://example-integration.com/oauth/callback
    OAuthClientCreateResponse:
      properties:
        id:
          type: integer
          exclusiveMinimum: 0.0
          examples:
          - value: 1
        client_id:
          type: string
          description: Public OAuth client_id
          examples:
          - value: oc_a1b2c3d4e5f6
        name:
          type: string
          description: Name of the OAuth client
          examples:
          - value: Example Integration
        description:
          oneOf:
          - type: string
          - type: 'null'
          description: Description of the OAuth client
          examples:
          - value: Third-party integration example
        redirect_uris:
          items:
            type: string
          type: array
          description: Allowed OAuth redirect URIs for this client
          examples:
          - value:
            - https://example-integration.com/oauth/callback
        workspace_id:
          type: integer
          exclusiveMinimum: 0.0
          description: Workspace ID the OAuth client is registered under
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          description: ID of the user who registered the OAuth client
        logo_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's logo, shown on the consent screen
        tos_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's terms of service
        privacy_url:
          oneOf:
          - type: string
          - type: 'null'
          description: https:// URL of the client's privacy policy
        token_endpoint_auth_method:
          type: string
          description: 'client_secret_basic (confidential, default) or none (a public client: PKCE only, no secret, loopback redirect URIs allowed)'
        created_at:
          type: string
          format: date-time
          description: When the OAuth client was registered
          examples:
          - value: '2021-09-28T11:30:00.000Z'
        client_secret:
          oneOf:
          - type: string
          - type: 'null'
          description: The client secret. Returned exactly once, at creation — only its SHA-256 digest is stored, so it cannot be retrieved again. Absent for a public client (token_endpoint_auth_method none).
          examples:
          - value: abcDefGhiJklMnoPqrStuVwxYz1234567890abcDefGhiJklM
      type: object
      required:
      - client_id
      - created_at
      - id
      - name
      - redirect_uris
      - token_endpoint_auth_method
      - user_id
      - workspace_id
      title: OAuthClientCreateResponse
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json