Info

IBM API Connect Platform - Consumer API 

Active
Download Me
Name : IBM API Connect Platform - Consumer API
Base Path : /undefined
Server : https://apimserver.example.com/consumer-api
Version : 1.0.2
Description : "This API provides operations for accessing API consumer content"

Paths


Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
expand query Active false Schema.type: boolean
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Me
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/Me application/yaml #/components/schemas/Me
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Me
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Responses:
Status Code Description Content-Type Schema
200: Successful delete application/json : application/yaml : #/components/schemas/Me
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/ChangePassword application/yaml #/components/schemas/ChangePassword
Request Responses:
Status Code Description Content-Type Schema
204: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/ResetPassword application/yaml #/components/schemas/ResetPassword
Request Responses:
Status Code Description Content-Type Schema
204: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
204: Success
302: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
offset query Active false Schema.type: integer
limit query Active false Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/MyPermissionList
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/Org application/yaml #/components/schemas/Org
Request Responses:
Status Code Description Content-Type Schema
201: Successful create application/json : application/yaml : #/components/schemas/Org
202: Success
302: Redirect response
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
offset query Active false Schema.type: integer
limit query Active false Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/OrgList
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
offset query Active false Schema.type: integer
limit query Active false Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/PermissionList
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
offset query Active false Schema.type: integer
limit query Active false Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/PermissionList
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Permission
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
offset query Active false Schema.type: integer
limit query Active false Schema.type: integer
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/PermissionList
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Permission
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/TokenRequest application/yaml #/components/schemas/TokenRequest
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/TokenResponse
201: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
state query Active false Schema.type: string
code query Active false Schema.type: string
error query Active false Schema.type: string
error_description query Active false Schema.type: string
error_uri query Active false Schema.type: string
oauth_token query Active false Schema.type: string
oauth_verifier query Active false Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
302: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
state query Active false Schema.type: string
code query Active false Schema.type: string
error query Active false Schema.type: string
error_description query Active false Schema.type: string
error_uri query Active false Schema.type: string
oauth_token query Active false Schema.type: string
oauth_verifier query Active false Schema.type: string
Request Body:
Description Required Content-Type Schema
application/x-www-form-urlencoded #/components/schemas/OauthRedirect
Request Responses:
Status Code Description Content-Type Schema
302: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
client_id query Active false Schema.type: string
state query Active false Schema.type: string
realm query Active true Schema.type: string
redirect_uri query Active false Schema.type: string
response_type query Active true Schema.type: string
token query Active false Schema.type: string
name query Active false Schema.type: string
title query Active false Schema.type: string
summary query Active false Schema.type: string
invitation_scope query Active false Schema.type: string
action query Active false Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
302: Success
4XX: #/components/responses/Error
5XX: #/components/responses/Error

Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
Request Body:
Description Required Content-Type Schema
Request Responses:
Status Code Description Content-Type Schema
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Org
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
fields query Active false Schema.type: string
Request Body:
Description Required Content-Type Schema
application/json #/components/schemas/Org application/yaml #/components/schemas/Org
Request Responses:
Status Code Description Content-Type Schema
200: Success application/json : application/yaml : #/components/schemas/Org
4XX: #/components/responses/Error
5XX: #/components/responses/Error
Raw view
Download Me
Request Parameters:
Approval Name In Required Schema
cascade query Active false Schema.type: boolean
Request Responses:
Status Code Description Content-Type Schema
200: Successful delete application/json :