Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Ibm Api Connect Oauth2 Action API
version: 2.0.0
contact:
name: IBM
url: https://www.ibm.com
email: help@ibm.com
license:
name: tbd
url: https://tbd.com
termsOfService: https://www.ibm.com/legal
x-refined-note:
- x-ibm-name differs across the merged source definitions and was not carried
description: 'Operations tagged Oauth2 Action across 2 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-management-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Oauth2 Action
paths:
/oauth2/redirect:
get:
summary: Authorization provider redirect endpoint
operationId: oauth2_redirect_get
parameters:
- $ref: '#/components/parameters/state'
- $ref: '#/components/parameters/code'
- $ref: '#/components/parameters/error'
- $ref: '#/components/parameters/error_description'
- $ref: '#/components/parameters/error_uri'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/oauth_verifier'
responses:
'302':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Oauth2 Action
post:
summary: Authorization provider redirect endpoint
operationId: oauth2_redirect_post
parameters:
- $ref: '#/components/parameters/state'
- $ref: '#/components/parameters/code'
- $ref: '#/components/parameters/error'
- $ref: '#/components/parameters/error_description'
- $ref: '#/components/parameters/error_uri'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/oauth_verifier'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/OauthRedirect'
responses:
'302':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Oauth2 Action
servers:
- url: ''
description: Consumer apim base path
components:
parameters:
oauth_token:
name: oauth_token
in: query
description: Oauth Token for Twitter
required: false
schema:
type: string
error_description:
name: error_description
in: query
description: Oauth2 error_description
required: false
schema:
type: string
error_uri:
name: error_uri
in: query
description: Oauth2 error_uri
required: false
schema:
type: string
code:
name: code
in: query
description: Oauth2 code
required: false
schema:
type: string
error:
name: error
in: query
description: Oauth2 error
required: false
schema:
type: string
state:
name: state
in: query
description: Oauth2 state
required: false
schema:
type: string
oauth_verifier:
name: oauth_verifier
in: query
description: Oauth Verifier for Twitter
required: false
schema:
type: string
error_description_2:
name: error_description
in: query
description: error_description per OAuth specification
required: false
schema:
type: string
error_uri_2:
name: error_uri
in: query
description: error_uri per OAuth specification
required: false
schema:
type: string
error_2:
name: error
in: query
description: error per OAuth specification
required: false
schema:
type: string
state_2:
name: state
in: query
description: State for a webhook event in subscriber queue
required: false
schema:
type: string
responses:
Error:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/yaml:
schema:
$ref: '#/components/schemas/Error'
schemas:
OauthRedirect:
type: object
additionalProperties: true
properties:
code:
type: string
state:
type: string
error:
type: string
error_description:
type: string
error_uri:
type: string
Error:
type: object
additionalProperties: false
properties:
status:
type: integer
minimum: 400
maximum: 599
message:
type: array
items:
type: string
errors:
type: array
items:
type: string
securitySchemes:
oauth:
type: oauth2
flows:
password:
tokenUrl: /token
refreshUrl: /token
scopes:
app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
my:manage: Update the Me object, Delete the Me object
my:view: Get the Me object, List the My Permission objects, List the My Organization objects
org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
authorizationCode:
authorizationUrl: /oauth2/authorize
tokenUrl: /token
refreshUrl: /token
scopes:
app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
my:manage: Update the Me object, Delete the Me object
my:view: Get the Me object, List the My Permission objects, List the My Organization objects
org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
x-refined-from:
- ibm-api-connect-consumer-api-openapi.yml
- ibm-api-connect-management-api-openapi.yml
x-ibm-configuration:
testable: false