IBM API Connect Platform - Consumer API
|
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" |
Name: IBM API Connect Platform - Consumer API
Server: https://apimserver.example.com/consumer-api
Version: 1.0.2
OperationID: | Path: | Verb: |
---|
Parameters |
Path | Ref |
---|
Parameter Name | IN | Required | LINK/TYPE |
---|
Request Body |
Path | Ref |
---|
Object Name | Field TYPE | PATTERN | ENUM | PARENT |
---|
Responses |
Path | Ref |
---|
Success Object | Field TYPE | PATTERN | ENUM | PARENT |
---|
No Payload Present
No Payload Present
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
fields | query | Active | false | Schema.type: string | |
expand | query | Active | false | Schema.type: boolean |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Me |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema | application/json | #/components/schemas/Me | application/yaml | #/components/schemas/Me |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Me |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Successful delete | application/json : application/yaml : | #/components/schemas/Me |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema | application/json | #/components/schemas/ChangePassword | application/yaml | #/components/schemas/ChangePassword |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
204: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema | application/json | #/components/schemas/ResetPassword | application/yaml | #/components/schemas/ResetPassword |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
204: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
204: | Success | ||
302: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/MyPermissionList |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema | application/json | #/components/schemas/Org | application/yaml | #/components/schemas/Org |
---|
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 |
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/OrgList |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/PermissionList |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/PermissionList |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
fields | query | Active | false | Schema.type: string |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Permission |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/PermissionList |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
fields | query | Active | false | Schema.type: string |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Permission |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema | application/json | #/components/schemas/TokenRequest | application/yaml | #/components/schemas/TokenRequest |
---|
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 |
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
302: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
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 |
Description | Required | Content-Type | Schema | application/x-www-form-urlencoded | #/components/schemas/OauthRedirect |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
302: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
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 |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
302: | Success | ||
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema |
---|
Description | Required | Content-Type | Schema |
---|
Status Code | Description | Content-Type | Schema |
---|
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
fields | query | Active | false | Schema.type: string |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Org |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
fields | query | Active | false | Schema.type: string |
Description | Required | Content-Type | Schema | application/json | #/components/schemas/Org | application/yaml | #/components/schemas/Org |
---|
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Success | application/json : application/yaml : | #/components/schemas/Org |
4XX: | #/components/responses/Error | ||
5XX: | #/components/responses/Error |
Approval | Name | In | Required | Schema | |
---|---|---|---|---|---|
cascade | query | Active | false | Schema.type: boolean |
Status Code | Description | Content-Type | Schema |
---|---|---|---|
200: | Successful delete | application/json : |