Introduction
API Connect is an integrated API management offering, with capabilities and tooling for all phases of the API lifecycle. Key steps of the API lifecycle include: create, secure, manage, socialize, and analyze.
These APIs enable you to permform actions as a consumer of the APIs that are published through the {{site.data.keyword.apiconnect}} service; for example, retrieve a list of Products, or subscribe to a product.
For more information on using API Connect, see: Getting started.
Authentication
Most API methods require an Authorization
header that includes a token with your IBM Cloud Identity and Access Management (IAM) credentials.
The header should look like this: Authorization: Bearer <token>
For more information, see Passing an IBM Cloud IAM token to authenticate with a service's API
Error handling
The APIs that you create and manage with API Connect use standard HTTP response codes to indicate whether a method completed successfully.
HTTP Error Code | Description | Recovery |
---|---|---|
200 |
Success | The request was successful. |
400 |
Bad Request | The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request. |
401 |
Unauthorized | You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact your account owner to check your permissions. |
403 |
Forbidden | The supplied authentication is not authorized. |
404 |
Not Found | The requested resource could not be found. |
408 |
Request Timeout | The connection to the server timed out. Wait a few minutes, then try again. |
409 |
Conflict | The entity is already in the requested state. |
429 |
Too Many Requests | You have made too many requests to this endpoint and are being rate limited / throttled. |
500 |
Internal Server Error | App ID is currently unavailable. Your request could not be processed. Wait a few minutes and try again. |
Methods
List all Permission objects in all collections
List all Permission objects in all collections
GET /consumer/permissions
Get the Permission object by name or id
Get the Permission object by name or id
GET /consumer/permissions/org/{permission}
Get the Permission object by name or id
Get the Permission object by name or id
GET /consumer/permissions/consumer/{permission}
Update the Organization object by name or id
Update the Organization object by name or id
PATCH /orgs/{org}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Delete the Organization object by name or id
Delete the Organization object by name or id
DELETE /orgs/{org}
Register using the Organization Invitation
Register using the Organization Invitation
POST /org-invitations/{invitation}/register
Accept using the Organization Invitation
Accept using the Organization Invitation
POST /org-invitations/{invitation}/accept
Create a Member Invitation object
Create a Member Invitation object
POST /orgs/{org}/member-invitations
List the Member Invitation objects
List the Member Invitation objects
GET /orgs/{org}/member-invitations
Get the Member Invitation object by name or id
Get the Member Invitation object by name or id
GET /orgs/{org}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Delete the Member Invitation object by name or id
DELETE /orgs/{org}/member-invitations/{member-invitation}
Regenerate the Member Invitation
Regenerate the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/regenerate
Register using the Member Invitation
Register using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/register
Accept using the Member Invitation
Accept using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/accept
Get the Associate object by name or id
Get the Associate object by name or id
GET /orgs/{org}/associates/{associate}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Get the Member object by name or id
Get the Member object by name or id
GET /orgs/{org}/members/{member}
Update the Member object by name or id
Update the Member object by name or id
PATCH /orgs/{org}/members/{member}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Member name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Delete the Member object by name or id
Delete the Member object by name or id
DELETE /orgs/{org}/members/{member}
Update the Role object by name or id
Update the Role object by name or id
PATCH /orgs/{org}/roles/{role}
Delete the Role object by name or id
Delete the Role object by name or id
DELETE /orgs/{org}/roles/{role}
Get the Payment Method object by name or id
Get the Payment Method object by name or id
GET /orgs/{org}/payment-methods/{payment-method}
Update the Payment Method object by name or id
Update the Payment Method object by name or id
PATCH /orgs/{org}/payment-methods/{payment-method}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Payment Method name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- configuration
- metadata
List all Permission objects in all collections
List all Permission objects in all collections
GET /consumer/permissions
Get the Permission object by name or id
Get the Permission object by name or id
GET /consumer/permissions/org/{permission}
Get the Permission object by name or id
Get the Permission object by name or id
GET /consumer/permissions/consumer/{permission}
Get the User Registry object by name or id
Get the User Registry object by name or id
GET /user-registries/{user-registry}
Search for users in the user registry
Search for users in the user registry
POST /user-registries/{user-registry}/search
Get the User object by name or id
Get the User object by name or id
GET /user-registries/{user-registry}/users/{user}
Authorization provider redirect endpoint
Authorization provider redirect endpoint
GET /oauth2/redirect
Authorization provider redirect endpoint
Authorization provider redirect endpoint
POST /oauth2/redirect
Authorization provider redirect endpoint
Authorization provider redirect endpoint
GET /oauth2/redirect
Authorization provider redirect endpoint
Authorization provider redirect endpoint
POST /oauth2/redirect
Update the Organization object by name or id
Update the Organization object by name or id
PATCH /orgs/{org}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Delete the Organization object by name or id
Delete the Organization object by name or id
DELETE /orgs/{org}
Register using the Organization Invitation
Register using the Organization Invitation
POST /org-invitations/{invitation}/register
Accept using the Organization Invitation
Accept using the Organization Invitation
POST /org-invitations/{invitation}/accept
Create a Member Invitation object
Create a Member Invitation object
POST /orgs/{org}/member-invitations
List the Member Invitation objects
List the Member Invitation objects
GET /orgs/{org}/member-invitations
Get the Member Invitation object by name or id
Get the Member Invitation object by name or id
GET /orgs/{org}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Delete the Member Invitation object by name or id
DELETE /orgs/{org}/member-invitations/{member-invitation}
Regenerate the Member Invitation
Regenerate the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/regenerate
Register using the Member Invitation
Register using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/register
Accept using the Member Invitation
Accept using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/accept
Get the User Registry object by name or id
Get the User Registry object by name or id
GET /user-registries/{user-registry}
Search for users in the user registry
Search for users in the user registry
POST /user-registries/{user-registry}/search
Get the User object by name or id
Get the User object by name or id
GET /user-registries/{user-registry}/users/{user}
List Identity Providers in the consumer realm
List Identity Providers in the consumer realm
GET /consumer/identity-providers
List Identity Providers in the consumer realm
List Identity Providers in the consumer realm
GET /consumer/identity-providers
Get the Associate object by name or id
Get the Associate object by name or id
GET /orgs/{org}/associates/{associate}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Get the Member object by name or id
Get the Member object by name or id
GET /orgs/{org}/members/{member}
Update the Member object by name or id
Update the Member object by name or id
PATCH /orgs/{org}/members/{member}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Member name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]- metadata
Delete the Member object by name or id
Delete the Member object by name or id
DELETE /orgs/{org}/members/{member}
Update the Role object by name or id
Update the Role object by name or id
PATCH /orgs/{org}/roles/{role}
Delete the Role object by name or id
Delete the Role object by name or id
DELETE /orgs/{org}/roles/{role}
List all Product objects in all collections
List all Product objects in all collections
GET /public-products
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product object by name and version
Get the Product object by name and version
GET /public-products/{product-name}/{product-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Product version name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product document by name and version
Get the Product document by name and version
GET /public-products/{product-name}/{product-version}/document
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API object by name and version
Get the API object by name and version
GET /public-apis/{api-name}/{api-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
API version name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API document by name and version
Get the API document by name and version
GET /public-apis/{api-name}/{api-version}/document
Get the API wsdl document by name and version
Get the API wsdl document by name and version
GET /public-apis/{api-name}/{api-version}/wsdl
List all Product objects in all collections
List all Product objects in all collections
GET /products
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product object by name and version
Get the Product object by name and version
GET /products/{product-name}/{product-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Product version name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product document by name and version
Get the Product document by name and version
GET /products/{product-name}/{product-version}/document
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API object by name and version
Get the API object by name and version
GET /apis/{api-name}/{api-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
API version name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API document by name and version
Get the API document by name and version
GET /apis/{api-name}/{api-version}/document
Get the API wsdl document by name and version
Get the API wsdl document by name and version
GET /apis/{api-name}/{api-version}/wsdl
List all Product objects in all collections
List all Product objects in all collections
GET /public-products
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product object by name and version
Get the Product object by name and version
GET /public-products/{product-name}/{product-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Product version name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product document by name and version
Get the Product document by name and version
GET /public-products/{product-name}/{product-version}/document
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API object by name and version
Get the API object by name and version
GET /public-apis/{api-name}/{api-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
API version name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API document by name and version
Get the API document by name and version
GET /public-apis/{api-name}/{api-version}/document
Get the API wsdl document by name and version
Get the API wsdl document by name and version
GET /public-apis/{api-name}/{api-version}/wsdl
List all Product objects in all collections
List all Product objects in all collections
GET /products
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product object by name and version
Get the Product object by name and version
GET /products/{product-name}/{product-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Product name
Product version name
Query Parameters
field name
Response
Possible values: [
product
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
published
,deprecated
]- product
Possible values: [
pending
,staged
,published
,deprecated
,retired
,archived
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the Product document by name and version
Get the Product document by name and version
GET /products/{product-name}/{product-version}/document
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API object by name and version
Get the API object by name and version
GET /apis/{api-name}/{api-version}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
API name
API version name
Query Parameters
field name
Response
Possible values: [
api
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
staged
,online
,offline
,retired
]- api
- info
- wsdl
Possible values: [
application/wsdl
,application/wsdl+xml
,text/xml
,application/zip
]
Possible values: [
rest
,wsdl
]Possible values: [
openapi2
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Get the API document by name and version
Get the API document by name and version
GET /apis/{api-name}/{api-version}/document
Get the API wsdl document by name and version
Get the API wsdl document by name and version
GET /apis/{api-name}/{api-version}/wsdl
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]Allowable values: [
development
,production
]Allowable values: [
production
]- metadata
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Successful create
Unexpected error
No Sample Response
Get the Application object by name or id
Get the Application object by name or id
GET /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Query Parameters
field name
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Update the Application object by name or id
Update the Application object by name or id
PATCH /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]Allowable values: [
development
,production
]Allowable values: [
production
]- metadata
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Delete the Application object by name or id
Delete the Application object by name or id
DELETE /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Successful delete
Unexpected error
No Sample Response
Get the Application Type object by name or id
Get the Application Type object by name or id
GET /application-types/{application-type}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Application Type name or id
Query Parameters
field name
Response
Possible values: [
application_type
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- oauth_types
Possible values: [
public
,confidential
]Possible values: [
password
,implicit
,access_code
,application
]
- metadata
Status Code
Success
Unexpected error
No Sample Response
Create a Application Credential object
Create a Application Credential object
POST /apps/{org}/{app}/credentials
List the Application Credential objects
List the Application Credential objects
GET /apps/{org}/{app}/credentials
Get the Application Credential object by name or id
Get the Application Credential object by name or id
GET /apps/{org}/{app}/credentials/{credential}
Update the Application Credential object by name or id
Update the Application Credential object by name or id
PATCH /apps/{org}/{app}/credentials/{credential}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Application Credential name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- metadata
Delete the Application Credential object by name or id
Delete the Application Credential object by name or id
DELETE /apps/{org}/{app}/credentials/{credential}
Reset the client id and client secret
Reset the client id and client secret
POST /apps/{org}/{app}/credentials/{credential}/reset
Reset the client secret
Reset the client secret
POST /apps/{org}/{app}/credentials/{credential}/reset-client-secret
Verify the client secret
Verify the client secret
POST /apps/{org}/{app}/credentials/{credential}/verify-client-secret
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Application Credential name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- metadata
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
pending
,enabled
,rejected
,disabled
]Allowable values: [
enabled
]- metadata
Response
Possible values: [
subscription
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
pending
,enabled
,rejected
,disabled
]Possible values: [
enabled
]- metadata
Status Code
Successful create
Unexpected error
No Sample Response
Get the Subscription object by name or id
Get the Subscription object by name or id
GET /apps/{org}/{app}/subscriptions/{subscription}
Update the Subscription object by name or id
Update the Subscription object by name or id
PATCH /apps/{org}/{app}/subscriptions/{subscription}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Subscription name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
pending
,enabled
,rejected
,disabled
]Allowable values: [
enabled
]- metadata
Delete the Subscription object by name or id
Delete the Subscription object by name or id
DELETE /apps/{org}/{app}/subscriptions/{subscription}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Subscription name or id
Response
Possible values: [
subscription
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
pending
,enabled
,rejected
,disabled
]Possible values: [
enabled
]- metadata
Status Code
Successful delete
Unexpected error
No Sample Response
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]Allowable values: [
development
,production
]Allowable values: [
production
]- metadata
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Successful create
Unexpected error
No Sample Response
Get the Application object by name or id
Get the Application object by name or id
GET /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Query Parameters
field name
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Update the Application object by name or id
Update the Application object by name or id
PATCH /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
enabled
,disabled
]Allowable values: [
development
,production
]Allowable values: [
production
]- metadata
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Success
Unexpected error
No Sample Response
Delete the Application object by name or id
Delete the Application object by name or id
DELETE /apps/{org}/{app}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Response
Possible values: [
app
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
enabled
,disabled
]Possible values: [
development
,production
]Possible values: [
production
]- metadata
Status Code
Successful delete
Unexpected error
No Sample Response
Get the Application Type object by name or id
Get the Application Type object by name or id
GET /application-types/{application-type}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Application Type name or id
Query Parameters
field name
Response
Possible values: [
application_type
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- oauth_types
Possible values: [
public
,confidential
]Possible values: [
password
,implicit
,access_code
,application
]
- metadata
Status Code
Success
Unexpected error
No Sample Response
Create a Application Credential object
Create a Application Credential object
POST /apps/{org}/{app}/credentials
List the Application Credential objects
List the Application Credential objects
GET /apps/{org}/{app}/credentials
Get the Application Credential object by name or id
Get the Application Credential object by name or id
GET /apps/{org}/{app}/credentials/{credential}
Update the Application Credential object by name or id
Update the Application Credential object by name or id
PATCH /apps/{org}/{app}/credentials/{credential}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Application Credential name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- metadata
Delete the Application Credential object by name or id
Delete the Application Credential object by name or id
DELETE /apps/{org}/{app}/credentials/{credential}
Reset the client id and client secret
Reset the client id and client secret
POST /apps/{org}/{app}/credentials/{credential}/reset
Reset the client secret
Reset the client secret
POST /apps/{org}/{app}/credentials/{credential}/reset-client-secret
Verify the client secret
Verify the client secret
POST /apps/{org}/{app}/credentials/{credential}/verify-client-secret
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Application Credential name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- metadata
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
pending
,enabled
,rejected
,disabled
]Allowable values: [
enabled
]- metadata
Response
Possible values: [
subscription
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
pending
,enabled
,rejected
,disabled
]Possible values: [
enabled
]- metadata
Status Code
Successful create
Unexpected error
No Sample Response
Get the Subscription object by name or id
Get the Subscription object by name or id
GET /apps/{org}/{app}/subscriptions/{subscription}
Update the Subscription object by name or id
Update the Subscription object by name or id
PATCH /apps/{org}/{app}/subscriptions/{subscription}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Subscription name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Allowable values: [
pending
,enabled
,rejected
,disabled
]Allowable values: [
enabled
]- metadata
Delete the Subscription object by name or id
Delete the Subscription object by name or id
DELETE /apps/{org}/{app}/subscriptions/{subscription}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Application name or id
Subscription name or id
Response
Possible values: [
subscription
]Possible values: [
2.0.0
]Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
Possible values: [
pending
,enabled
,rejected
,disabled
]Possible values: [
enabled
]- metadata
Status Code
Successful delete
Unexpected error
No Sample Response
Get the Billing object by name or id
Get the Billing object by name or id
GET /orgs/{org}/billings/{billing}
Get the Billing object by name or id
Get the Billing object by name or id
GET /orgs/{org}/billings/{billing}
Get the Payment Method object by name or id
Get the Payment Method object by name or id
GET /orgs/{org}/payment-methods/{payment-method}
Update the Payment Method object by name or id
Update the Payment Method object by name or id
PATCH /orgs/{org}/payment-methods/{payment-method}
Request
Custom Headers
Allowable values: [
application/json
,application/yaml
]Allowable values: [
application/json
,application/yaml
]
Path Parameters
Organization name or id
Payment Method name or id
Possible values: length ≤ 255
Possible values: length ≤ 1023
Possible values: length ≤ 65535
- configuration
- metadata