mammoth-io OAuth Consent API
The OAuth Consent API from mammoth-io — 9 operation(s) for oauth consent.
The OAuth Consent API from mammoth-io — 9 operation(s) for oauth consent.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/mammoth-io:mammoth-io-oauth-consent-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mammoth Io OAuth Consent API
version: 0.1.0
contact:
name: Mammoth Analytics
url: https://mammoth.io
email: support@mammoth.io
description: 'Operations tagged OAuth Consent 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 Consent
paths:
/oauth/authorize:
get:
tags:
- OAuth Consent
summary: 'Standard authorize URL: forwards to the consent page'
operationId: AuthorizeRedirect
parameters: []
responses:
'302':
description: Object moved temporarily -- see URI list
headers: {}
content:
application/json:
schema: {}
deprecated: false
servers:
- url: /api/v2
/oauth/device-approve:
post:
tags:
- OAuth Consent
summary: Approve a CLI device sign-in
operationId: ApproveDevice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceApprove'
required: true
responses:
'204':
description: Decision recorded
'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
/oauth/consent:
post:
tags:
- OAuth Consent
summary: 'Allow: issue a one-time code and return to the app'
operationId: Authorize
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizeAllow'
required: true
responses:
'200':
description: Return to the app
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentRedirect'
'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
'404':
description: Not found
deprecated: false
servers:
- url: /api/v2
/oauth/consent/deny:
post:
tags:
- OAuth Consent
summary: 'Deny: return to the app with access_denied'
operationId: Deny
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizeDeny'
required: true
responses:
'200':
description: Return to the app
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentRedirect'
'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
'404':
description: Not found
deprecated: false
servers:
- url: /api/v2
/oauth/device-deny:
post:
tags:
- OAuth Consent
summary: Deny a CLI device sign-in
operationId: DenyDevice
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDeny'
required: true
responses:
'204':
description: Decision recorded
'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
/oauth/consent-info:
get:
tags:
- OAuth Consent
summary: Data for the OAuth consent screen
operationId: GetConsentInfo
parameters:
- name: client_id
in: query
schema:
type: string
minLength: 1
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: redirect_uri
in: query
schema:
type: string
minLength: 1
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: code_challenge
in: query
schema:
type: string
minLength: 1
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: code_challenge_method
in: query
schema:
type: string
minLength: 1
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: state
in: query
schema:
oneOf:
- type: string
- type: 'null'
maxLength: 2048
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: resource
in: query
schema:
oneOf:
- type: string
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: workspace_id
in: query
schema:
oneOf:
- type: integer
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: Consent screen data
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentInfo'
'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
'404':
description: Not found
deprecated: false
servers:
- url: /api/v2
/oauth/device-info:
get:
tags:
- OAuth Consent
summary: Data for the device sign-in screen
operationId: GetDeviceInfo
parameters:
- name: user_code
in: query
schema:
type: string
minLength: 1
required: true
deprecated: false
allowEmptyValue: false
allowReserved: false
- name: workspace_id
in: query
schema:
oneOf:
- type: integer
- type: 'null'
required: false
deprecated: false
allowEmptyValue: false
allowReserved: false
responses:
'200':
description: Device sign-in screen data
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceConsentInfo'
'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
/self/oauth-grants:
get:
tags:
- OAuth Consent
summary: List the apps you have connected
operationId: ListConnectedApps
responses:
'200':
description: Connected apps
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectedAppsList'
'401':
description: Authorization error
deprecated: false
servers:
- url: /api/v2
/self/oauth-grants/{oauth_grant_id}:
delete:
tags:
- OAuth Consent
summary: Disconnect an app
description: 'Takes effect on the app''s very next call: its access and refresh tokens stop working.'
operationId: RevokeConnectedApp
parameters:
- name: oauth_grant_id
in: path
schema:
type: integer
minimum: 1.0
title: Connected app ID
description: ID of the connected app to disconnect
examples:
- 1
description: ID of the connected app to disconnect
required: true
deprecated: false
examples:
oauth_grant_id-example-1:
value: 1
responses:
'204':
description: Access revoked
'400':
description: Bad request syntax or unsupported method
content:
application/json:
schema:
oneOf:
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Client Error
examples:
- status_code: 400
detail: Bad Request
extra: {}
- properties:
status_code:
type: integer
detail:
type: string
extra:
additionalProperties: {}
type:
- 'null'
- object
- array
type: object
required:
- detail
- status_code
description: Validation Exception
examples:
- status_code: 400
detail: Bad Request
extra: {}
'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: {}
'404':
description: Not found
'401':
description: Authorization error
deprecated: false
servers:
- url: /api/v2
components:
schemas:
ConsentRedirect:
properties:
redirect_url:
type: string
description: 'Where to send the browser next: back to the app'
type: object
required:
- redirect_url
title: ConsentRedirect
DeviceDeny:
properties:
user_code:
type: string
maxLength: 32
minLength: 1
workspace_id:
oneOf:
- type: integer
- type: 'null'
type: object
required:
- user_code
title: DeviceDeny
DeviceApprove:
properties:
project_id:
oneOf:
- type: integer
- type: 'null'
description: One project; with project_ids it must be one of them
project_ids:
oneOf:
- items:
type: integer
type: array
- type: 'null'
maxLength: 200
minLength: 1
description: The projects to pin the sign-in to; null = "All projects"
user_code:
type: string
maxLength: 32
minLength: 1
workspace_id:
oneOf:
- type: integer
- type: 'null'
read_only:
type: boolean
description: 'Grant read-only access: the app may read but never change anything'
default: false
type: object
required:
- user_code
title: DeviceApprove
ConsentUser:
properties:
email:
type: string
name:
oneOf:
- type: string
- type: 'null'
type: object
required:
- email
title: ConsentUser
ConsentProject:
properties:
id:
type: integer
name:
type: string
type: object
required:
- id
- name
title: ConsentProject
ConsentInfo:
properties:
client:
$ref: '#/components/schemas/ConsentClient'
user:
$ref: '#/components/schemas/ConsentUser'
workspace:
$ref: '#/components/schemas/ConsentWorkspace'
has_workspace_access:
type: boolean
description: False when the user is not an active member of the app's workspace
workspace_selectable:
type: boolean
description: True when the workspace the person picks is the one used; false when the app is bound to its own workspace
projects:
items:
$ref: '#/components/schemas/ConsentProject'
type: array
already_connected:
oneOf:
- $ref: '#/components/schemas/AlreadyConnected'
- type: 'null'
description: 'Set when the user already connected this app: the screen skips consent and re-approves with this project'
type: object
required:
- client
- has_workspace_access
- projects
- user
- workspace
- workspace_selectable
title: ConsentInfo
AuthorizeAllow:
properties:
project_id:
oneOf:
- type: integer
- type: 'null'
description: One project; with project_ids it must be one of them
project_ids:
oneOf:
- items:
type: integer
type: array
- type: 'null'
maxLength: 200
minLength: 1
description: The projects to pin the sign-in to; null = "All projects"
client_id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
state:
oneOf:
- type: string
- type: 'null'
maxLength: 2048
code_challenge:
type: string
minLength: 1
code_challenge_method:
type: string
minLength: 1
read_only:
type: boolean
description: 'Grant read-only access: the app may read but never change anything'
default: false
resource:
oneOf:
- type: string
- type: 'null'
maxLength: 500
workspace_id:
oneOf:
- type: integer
- type: 'null'
type: object
required:
- client_id
- code_challenge
- code_challenge_method
- redirect_uri
title: AuthorizeAllow
DeviceConsentInfo:
properties:
client:
$ref: '#/components/schemas/ConsentClient'
user:
$ref: '#/components/schemas/ConsentUser'
workspace:
$ref: '#/components/schemas/ConsentWorkspace'
has_workspace_access:
type: boolean
description: False when the user is not an active member of the app's workspace
workspace_selectable:
type: boolean
description: True when the workspace the person picks is the one used; false when the app is bound to its own workspace
projects:
items:
$ref: '#/components/schemas/ConsentProject'
type: array
already_connected:
oneOf:
- $ref: '#/components/schemas/AlreadyConnected'
- type: 'null'
description: 'Set when the user already connected this app: the screen skips consent and re-approves with this project'
user_code:
type: string
description: The code as shown to the person, XXXX-XXXX
type: object
required:
- client
- has_workspace_access
- projects
- user
- user_code
- workspace
- workspace_selectable
title: DeviceConsentInfo
ConnectedApp:
properties:
id:
type: integer
client_name:
oneOf:
- type: string
- type: 'null'
client_logo_url:
oneOf:
- type: string
- type: 'null'
workspace_id:
type: integer
workspace_name:
oneOf:
- type: string
- type: 'null'
project_id:
oneOf:
- type: integer
- type: 'null'
description: null = "All projects" in the workspace
project_name:
oneOf:
- type: string
- type: 'null'
projects:
oneOf:
- items:
$ref: '#/components/schemas/ConsentProject'
type: array
- type: 'null'
description: Every project the app is pinned to; null = "All projects"
read_only:
type: boolean
description: True when the app may read but not change data
default: false
created_at:
type: string
format: date-time
type: object
required:
- created_at
- id
- workspace_id
title: ConnectedApp
AuthorizeDeny:
properties:
client_id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
state:
oneOf:
- type: string
- type: 'null'
maxLength: 2048
type: object
required:
- client_id
- redirect_uri
title: AuthorizeDeny
ConsentWorkspace:
properties:
id:
type: integer
name:
type: string
type: object
required:
- id
- name
title: ConsentWorkspace
ConsentClient:
properties:
client_id:
type: string
name:
type: string
logo_url:
oneOf:
- type: string
- type: 'null'
tos_url:
oneOf:
- type: string
- type: 'null'
privacy_url:
oneOf:
- type: string
- type: 'null'
type: object
required:
- client_id
- name
title: ConsentClient
ConnectedAppsList:
properties:
result:
items:
$ref: '#/components/schemas/ConnectedApp'
type: array
type: object
required:
- result
title: ConnectedAppsList
AlreadyConnected:
properties:
project_id:
oneOf:
- type: integer
- type: 'null'
description: The lowest project the app is already connected to; null = "All projects"
project_ids:
oneOf:
- items:
type: integer
type: array
- type: 'null'
description: Every project the app is already connected to; null = "All projects"
read_only:
type: boolean
description: True when the connection was granted read-only; a re-approval must send it back, or the grant widens to full access
type: object
required:
- read_only
title: AlreadyConnected
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