Platform GST

Info

IBM API Connect Platform - Consumer API

Active

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"

Operation ID:

Parent API

Name: IBM API Connect Platform - Consumer API

Server: https://apimserver.example.com/consumer-api

Version: 1.0.2

Build ID: 82a60154-8b51-4342-9bf8-54a78b080a77

Date Issues: 2025/10/30

Date Created: NAN

Note:

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

Paths

Optional

New Path

Select Methodes

GET

Operation ID

GET operation

POST

Operation ID

POST operations

PUT

Operation ID

Put operations

Delete

Operation ID

Delete operations

HEAD

Operation ID

HEAD operations

PATCH

Operation ID

PATCH operations

/me

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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

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

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

/me/change-password

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	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/me/reset-password

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	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/me/sign-out

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Schema
204:	Success
302:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/permissions

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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

/orgs

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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

Request Parameters:

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

/consumer/permissions

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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

/consumer/permissions/org

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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

/consumer/permissions/org/{permission}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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

/consumer/permissions/consumer

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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

/consumer/permissions/consumer/{permission}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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

/token

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

/oauth2/redirect

Request Parameters:

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	Schema
302:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

Request Parameters:

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	Schema
302:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/oauth2/authorize

Request Parameters:

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	Schema
302:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/orgs/{org}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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

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

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 : application/yaml :	#/components/schemas/Org
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/transfer-owner

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/TransferOwner	application/yaml	#/components/schemas/TransferOwner

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

/groups/{group}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Group
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/org-invitations/{invitation}/register

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	X-IBM-Client-Id	header	Active	false	Schema.type: string
	X-IBM-Client-Secret	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/InvitationRegister	application/yaml	#/components/schemas/InvitationRegister

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/MemberRegisterResponse
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/org-invitations/{invitation}/accept

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	X-IBM-Client-Id	header	Active	false	Schema.type: string
	X-IBM-Client-Secret	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/InvitationAccept	application/yaml	#/components/schemas/InvitationAccept

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/MemberAcceptResponse
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/member-invitations

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/MemberInvitation	application/yaml	#/components/schemas/MemberInvitation

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/MemberInvitation
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/MemberInvitationList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema
	confirm	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/orgs/{org}/member-invitations/{member-invitation}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/MemberInvitation
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Successful delete	application/json : application/yaml :	#/components/schemas/MemberInvitation
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/member-invitations/{member-invitation}/regenerate

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Regenerate	application/yaml	#/components/schemas/Regenerate

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/MemberInvitation
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/member-invitations/{member-invitation}/register

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	X-IBM-Client-Id	header	Active	false	Schema.type: string
	X-IBM-Client-Secret	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/MemberInvitationRegister	application/yaml	#/components/schemas/MemberInvitationRegister

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/MemberRegisterResponse
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/member-invitations/{member-invitation}/accept

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	X-IBM-Client-Id	header	Active	false	Schema.type: string
	X-IBM-Client-Secret	header	Active	false	Schema.type: string

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/MemberInvitationAccept	application/yaml	#/components/schemas/MemberInvitationAccept

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/MemberAcceptResponse
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/user-registries

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/UserRegistryList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/user-registries/{user-registry}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/UserRegistry
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/user-registries/{user-registry}/search

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	offset	query	Active	false	Schema.type: integer
	limit	query	Active	false	Schema.type: integer

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/UserSearch	application/yaml	#/components/schemas/UserSearch

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/UserList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/user-registries/{user-registry}/users/{user}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/User
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/sign-up

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/SignUp	application/yaml	#/components/schemas/SignUp

Request Responses:

Status Code	Description	Schema
201:	Success
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/activate

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/request-password-reset

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/RequestPasswordReset	application/yaml	#/components/schemas/RequestPasswordReset

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/consumer/identity-providers

Request Parameters:

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/IdentityProviderList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/associates

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/AssociateList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/associates/{associate}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Associate
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/members

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Member	application/yaml	#/components/schemas/Member

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/Member
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/MemberList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema
	confirm	query	Active	false	Schema.type: string
	cascade	query	Active	false	Schema.type: boolean

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/orgs/{org}/members/{member}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Member
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Member	application/yaml	#/components/schemas/Member

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/Member
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

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 : application/yaml :	#/components/schemas/Member
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/roles

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/RoleList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/roles/{role}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Role
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/ProductList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products/{product-name}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/ProductList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products/{product-id}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Product
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products/{product-name}/{product-version}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Product
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products/{product-id}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/ProductDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-products/{product-name}/{product-version}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/ProductDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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
api_type	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-name}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/APIList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-id}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/API
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-name}/{api-version}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/API
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-id}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-name}/{api-version}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-id}/wsdl

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	endpoint	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml : application/wsdl : application/zip :
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/public-apis/{api-name}/{api-version}/wsdl

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	endpoint	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml : application/wsdl : application/zip :
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/ProductList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products/{product-name}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/ProductList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products/{product-id}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Product
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products/{product-name}/{product-version}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Product
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products/{product-id}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/ProductDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/products/{product-name}/{product-version}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/ProductDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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
api_type	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-name}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/APIList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-id}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/API
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-name}/{api-version}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/API
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-id}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-name}/{api-version}/document

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/APIDocument
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-id}/wsdl

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	endpoint	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml : application/wsdl : application/zip :
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apis/{api-name}/{api-version}/wsdl

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema
	endpoint	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml : application/wsdl : application/zip :
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/apps

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/App	application/yaml	#/components/schemas/App

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/App
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/AppList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema
	confirm	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/apps/{org}/{app}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/App
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/App	application/yaml	#/components/schemas/App

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/App
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Successful delete	application/json : application/yaml :	#/components/schemas/App
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apps/{org}/{app}/credentials

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Credential	application/yaml	#/components/schemas/Credential

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/Credential
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/CredentialList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema
	confirm	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/apps/{org}/{app}/credentials/{credential}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Credential
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Credential	application/yaml	#/components/schemas/Credential

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/Credential
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Successful delete	application/json : application/yaml :	#/components/schemas/Credential
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apps/{org}/{app}/credentials/{credential}/reset

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/Credential
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apps/{org}/{app}/credentials/{credential}/reset-client-secret

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/Credential
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apps/{org}/{app}/credentials/{credential}/verify-client-secret

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Credential	application/yaml	#/components/schemas/Credential

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Success	application/json : application/yaml :	#/components/schemas/Credential
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/apps/{org}/{app}/subscriptions

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Subscription	application/yaml	#/components/schemas/Subscription

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/Subscription
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/SubscriptionList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema
	confirm	query	Active	false	Schema.type: string

Request Responses:

Status Code	Description	Schema
204:	Success
4XX:		#/components/responses/Error
5XX:		#/components/responses/Error

/apps/{org}/{app}/subscriptions/{subscription}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Subscription
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/Subscription	application/yaml	#/components/schemas/Subscription

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/Subscription
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Successful delete	application/json : application/yaml :	#/components/schemas/Subscription
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/billings

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/BillingList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/billings/{billing}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/Billing
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/payment-methods

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/PaymentMethod	application/yaml	#/components/schemas/PaymentMethod

Request Responses:

Status Code	Description	Content-Type	Schema
201:	Successful create	application/json : application/yaml :	#/components/schemas/PaymentMethod
302:	Redirect response
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

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/PaymentMethodList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/orgs/{org}/payment-methods/{payment-method}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/PaymentMethod
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema
application/json	#/components/schemas/PaymentMethod	application/yaml	#/components/schemas/PaymentMethod

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Success	application/json : application/yaml :	#/components/schemas/PaymentMethod
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Request Parameters:

Approval	Name	In		Required	Schema

Request Responses:

Status Code	Description	Content-Type	Schema
200:	Successful delete	application/json : application/yaml :	#/components/schemas/PaymentMethod
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/payment-method-types

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

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/PaymentMethodTypeList
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

/payment-method-types/{payment-method-type}

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

Request Parameters:

Approval	Name	In		Required	Schema

Request Body:

Description	Required	Content-Type	Schema

Request Responses:

Status Code	Description	Content-Type	Schema

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/PaymentMethodType
4XX:			#/components/responses/Error
5XX:			#/components/responses/Error

Components

Info

IBM API Connect Platform - Consumer API Active

Parameters

Request Body

Responses

Paths

Select Methodes

/me

/me/change-password

/me/reset-password

/me/sign-out

/permissions

/orgs

/consumer/permissions

/consumer/permissions/org

/consumer/permissions/org/{permission}

/consumer/permissions/consumer

/consumer/permissions/consumer/{permission}

/token

/oauth2/redirect

/oauth2/authorize

/orgs/{org}

/orgs/{org}/transfer-owner

/groups/{group}

/org-invitations/{invitation}/register

/org-invitations/{invitation}/accept

/orgs/{org}/member-invitations

/orgs/{org}/member-invitations/{member-invitation}

/orgs/{org}/member-invitations/{member-invitation}/regenerate

/orgs/{org}/member-invitations/{member-invitation}/register

/orgs/{org}/member-invitations/{member-invitation}/accept

/user-registries

/user-registries/{user-registry}

/user-registries/{user-registry}/search

/user-registries/{user-registry}/users/{user}

/sign-up

/activate

/request-password-reset

/consumer/identity-providers

/orgs/{org}/associates

/orgs/{org}/associates/{associate}

/orgs/{org}/members

/orgs/{org}/members/{member}

/orgs/{org}/roles

/orgs/{org}/roles/{role}

/public-products

/public-products/{product-name}

/public-products/{product-id}

/public-products/{product-name}/{product-version}

/public-products/{product-id}/document

/public-products/{product-name}/{product-version}/document

/public-apis

/public-apis/{api-name}

/public-apis/{api-id}

/public-apis/{api-name}/{api-version}

/public-apis/{api-id}/document

/public-apis/{api-name}/{api-version}/document

/public-apis/{api-id}/wsdl

/public-apis/{api-name}/{api-version}/wsdl

/products

/products/{product-name}

/products/{product-id}

/products/{product-name}/{product-version}

/products/{product-id}/document

/products/{product-name}/{product-version}/document

/apis

/apis/{api-name}

/apis/{api-id}

/apis/{api-name}/{api-version}

/apis/{api-id}/document

/apis/{api-name}/{api-version}/document

/apis/{api-id}/wsdl

/apis/{api-name}/{api-version}/wsdl

/orgs/{org}/apps

/apps/{org}/{app}

/apps/{org}/{app}/credentials

/apps/{org}/{app}/credentials/{credential}

/apps/{org}/{app}/credentials/{credential}/reset

/apps/{org}/{app}/credentials/{credential}/reset-client-secret

/apps/{org}/{app}/credentials/{credential}/verify-client-secret

IBM API Connect Platform - Consumer API

Active