Create a User Registry object
POST /orgs/{org}/user-registries
Create a User Registry object
Request
Request Body
UserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
configuration
object
endpoint
SecuredEndpoint
endpoint
Required *
string
tls_client_profile_url
string
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
configuration
object
endpoint
SecuredEndpoint
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the User Registry objects
GET /orgs/{org}/user-registries
List the User Registry objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the User Registry objects
DELETE /orgs/{org}/user-registries
Clear the User Registry objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the User Registry object by name or id
GET /user-registries/{org}/{user-registry}
Get the User Registry object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
configuration
object
endpoint
SecuredEndpoint
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the User Registry object by name or id
PATCH /user-registries/{org}/{user-registry}
Update the User Registry object by name or id
Request
Request Body
UserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
configuration
object
endpoint
SecuredEndpoint
endpoint
Required *
string
tls_client_profile_url
string
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
configuration
object
endpoint
SecuredEndpoint
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the User Registry object by name or id
DELETE /user-registries/{org}/{user-registry}
Delete the User Registry object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
ResourceVisibility
configuration
object
endpoint
SecuredEndpoint
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Execute a User Registry operation
POST /user-registries/{org}/{user-registry}/execute
Execute a User Registry operation
Request
Path Parameters
Query Parameters
operation
Required *
string
Operation to perform on the user registry (get_base_dn_list, validate_password)
Response
200 - Success
default -
Test a User Registry connection
POST /user-registries/{org}/{user-registry}/test-connection
Test a User Registry connection
Request
Request Body
TestConnectionCredentials
username
string
password
string
Response
204 - Success
400 - Failure
status
integer
message
array
errors
array
default -
Execute a User Registry operation
POST /orgs/{org}/user-registries/execute
Execute a User Registry operation
Request
Request Body
UserRegistryExecute
user_registry
UserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
object
configuration
object
endpoint
object
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Path Parameters
Query Parameters
operation
Required *
string
Operation to perform on the user registry (get_base_dn_list, validate_password)
Response
200 - Success
default -
Test a User Registry connection
POST /orgs/{org}/user-registries/test-connection
Test a User Registry connection
Request
Request Body
UserRegistryTestConnection
user_registry
UserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
visibility
object
configuration
object
endpoint
object
owned
boolean
configured_catalog_user_registry_urls
array
configured_api_user_registry_urls
array
configured_oauth_provider_urls
array
member_urls
array
oauth_provider_urls
array
user_registry_setting_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
credentials
TestConnectionCredentials
username
string
password
string
Response
204 - Success
400 - Failure
status
integer
message
array
errors
array
default -
Search for users in the user registry
POST /user-registries/{org}/{user-registry}/search
Search for users in the user registry
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Create a User object
POST /user-registries/{org}/{user-registry}/users
Create a User object
Request
Request Body
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the User objects
GET /user-registries/{org}/{user-registry}/users
List the User objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the User objects
DELETE /user-registries/{org}/{user-registry}/users
Clear the User objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the User object by name or id
GET /user-registries/{org}/{user-registry}/users/{user}
Get the User object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the User object by name or id
PATCH /user-registries/{org}/{user-registry}/users/{user}
Update the User object by name or id
Request
Request Body
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the User object by name or id
DELETE /user-registries/{org}/{user-registry}/users/{user}
Delete the User object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Send reset password link
POST /request-password-reset
Send reset password link
Request
Request Body
RequestPasswordReset
realm
string
string
Response
204 - Success
default -
Reset password
POST /user-registries/{org}/{user-registry}/users/{user}/reset-password
Reset password
Request
Request Body
ResetPassword
password
string
Response
204 - Success
default -
Search for users in the admin realm
POST /cloud/admin/search/user
Search for users in the admin realm
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Search for users in the provider realm
POST /cloud/provider/search/user
Search for users in the provider realm
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List Identity Providers in the admin realm
GET /cloud/admin/identity-providers
List Identity Providers in the admin realm
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List Identity Providers in the provider realm
GET /cloud/provider/identity-providers
List Identity Providers in the provider realm
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Generate a token
POST /token
Generate a token
Request
Request Body
TokenRequest
username
string
password
string
assertion
string
realm
string
client_id
string
client_secret
string
code
string
refresh_token
string
api_key
string
grant_type
Required *
string
Response
200 - Success
access_token
string
token_type
string
expires_in
integer
refresh_token
string
refresh_expires_in
integer
default -
Authorization provider redirect endpoint
GET /oauth2/redirect
Authorization provider redirect endpoint
Request
Path Parameters
Query Parameters
state
string
State for a webhook event in subscriber queue
code
string
Oauth2 code
error
string
error per OAuth specification
error_description
string
error_description per OAuth specification
error_uri
string
error_uri per OAuth specification
oauth_token
string
Oauth Token for Twitter
oauth_verifier
string
Oauth Verifier for Twitter
Response
302 - Success
default -
Authorization provider redirect endpoint
POST /oauth2/redirect
Authorization provider redirect endpoint
Request
Request Body
OauthRedirect
code
string
state
string
error
string
error_description
string
error_uri
string
Path Parameters
Query Parameters
state
string
State for a webhook event in subscriber queue
code
string
Oauth2 code
error
string
error per OAuth specification
error_description
string
error_description per OAuth specification
error_uri
string
error_uri per OAuth specification
oauth_token
string
Oauth Token for Twitter
oauth_verifier
string
Oauth Verifier for Twitter
Response
302 - Success
default -
Create a API Key object
POST /cloud/api-keys
Create a API Key object
Request
Request Body
APIKey
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_type
string
realm
string
user_url
string
id_token
string
token_exp
integer
token_iat
integer
token_jti
string
api_key
string
description
string
ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_type
string
realm
string
user_url
string
id_token
string
token_exp
integer
token_iat
integer
token_jti
string
api_key
string
description
string
ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
List the API Key objects
GET /cloud/api-keys
List the API Key objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the API Key object by name or id
GET /cloud/api-keys/{api-key}
Get the API Key object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_type
string
realm
string
user_url
string
id_token
string
token_exp
integer
token_iat
integer
token_jti
string
api_key
string
description
string
ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the API Key object by name or id
DELETE /cloud/api-keys/{api-key}
Delete the API Key object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_type
string
realm
string
user_url
string
id_token
string
token_exp
integer
token_iat
integer
token_jti
string
api_key
string
description
string
ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Organization Setting object
GET /orgs/{org}/settings
Get the Organization Setting object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Organization Setting object
PUT /orgs/{org}/settings
Update the Organization Setting object
Request
Request Body
OrgSetting
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
custom
boolean
name
string
address
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Notification Template objects in all collections
GET /orgs/{org}/settings/notification-templates
List all Notification Template objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Notification Template objects
GET /orgs/{org}/settings/notification-templates/provider
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /orgs/{org}/settings/notification-templates/provider/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /orgs/{org}/settings/notification-templates/provider/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /orgs/{org}/settings/notification-templates/catalog
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /orgs/{org}/settings/notification-templates/catalog/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /orgs/{org}/settings/notification-templates/catalog/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /orgs/{org}/settings/notification-templates/space
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /orgs/{org}/settings/notification-templates/space/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /orgs/{org}/settings/notification-templates/space/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /orgs/{org}/settings/notification-templates/consumer
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /orgs/{org}/settings/notification-templates/consumer/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /orgs/{org}/settings/notification-templates/consumer/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Organization object by name or id
GET /orgs/{org}
Get the Organization object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
org_type
string
state
string
owner_url
string
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Organization object by name or id
PATCH /orgs/{org}
Update the Organization object by name or id
Request
Request Body
Org
type
string
api_version
string
id
string
name
string
title
string
summary
string
org_type
string
state
string
owner_url
string
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
org_type
string
state
string
owner_url
string
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Organization object by name or id
DELETE /orgs/{org}
Delete the Organization object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
org_type
string
state
string
owner_url
string
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Transfer owner to an associate
POST /orgs/{org}/transfer-owner
Transfer owner to an associate
Request
Request Body
TransferOwner
new_owner_associate_url
string
new_owner_member_url
string
old_owner_new_role_urls
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
org_type
string
state
string
owner_url
string
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Search provider users from an organization.
POST /orgs/{org}/search/user
Search provider users from an organization.
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Associate objects
GET /orgs/{org}/associates
List the Associate objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Associate object by name or id
GET /orgs/{org}/associates/{associate}
Get the Associate object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member Invitation object
POST /orgs/{org}/member-invitations
Create a Member Invitation object
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member Invitation objects
GET /orgs/{org}/member-invitations
List the Member Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member Invitation objects
DELETE /orgs/{org}/member-invitations
Clear the Member Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member Invitation object by name or id
GET /orgs/{org}/member-invitations/{member-invitation}
Get the Member Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member Invitation object by name or id
PATCH /orgs/{org}/member-invitations/{member-invitation}
Update the Member Invitation object by name or id
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member Invitation object by name or id
DELETE /orgs/{org}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/regenerate
Regenerate the Member Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Register using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/register
Register using the Member Invitation
Request
Request Body
MemberInvitationRegister
client_id
string
client_secret
string
realm
string
username
string
password
string
string
first_name
string
last_name
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Accept using the Member Invitation
POST /orgs/{org}/member-invitations/{member-invitation}/accept
Accept using the Member Invitation
Request
Request Body
MemberInvitationAccept
client_id
string
client_secret
string
realm
string
username
string
password
string
token
string
token_secret
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Create a Member object
POST /orgs/{org}/members
Create a Member object
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member objects
GET /orgs/{org}/members
List the Member objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member objects
DELETE /orgs/{org}/members
Clear the Member objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member object by name or id
GET /orgs/{org}/members/{member}
Get the Member object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member object by name or id
PATCH /orgs/{org}/members/{member}
Update the Member object by name or id
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member object by name or id
DELETE /orgs/{org}/members/{member}
Delete the Member object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Permission objects in all collections
GET /cloud/permissions
List all Permission objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Permission objects
GET /cloud/permissions/org
List the Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Permission object by name or id
GET /cloud/permissions/org/{permission}
Get the Permission object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
permission_type
string
title
string
summary
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Permission objects
GET /cloud/permissions/cloud
List the Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Permission object by name or id
GET /cloud/permissions/cloud/{permission}
Get the Permission object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
permission_type
string
title
string
summary
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Permission objects
GET /cloud/permissions/provider
List the Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Permission object by name or id
GET /cloud/permissions/provider/{permission}
Get the Permission object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
permission_type
string
title
string
summary
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Permission objects
GET /cloud/permissions/consumer
List the Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Permission object by name or id
GET /cloud/permissions/consumer/{permission}
Get the Permission object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
permission_type
string
title
string
summary
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Permission objects
GET /cloud/permissions/deployment
List the Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Permission object by name or id
GET /cloud/permissions/deployment/{permission}
Get the Permission object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
permission_type
string
title
string
summary
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Role object
POST /orgs/{org}/roles
Create a Role object
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role objects
GET /orgs/{org}/roles
List the Role objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Role objects
DELETE /orgs/{org}/roles
Clear the Role objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Role object by name or id
GET /orgs/{org}/roles/{role}
Get the Role object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role object by name or id
PATCH /orgs/{org}/roles/{role}
Update the Role object by name or id
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Role object by name or id
DELETE /orgs/{org}/roles/{role}
Delete the Role object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Gateway Service objects
GET /orgs/{org}/gateway-services
List the Gateway Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Gateway Service object by name or id
GET /orgs/{org}/gateway-services/{gateway-service}
Get the Gateway Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
gateway_service_type
string
endpoint
string
api_endpoint_base
string
tls_client_profile_url
string
sni
array
oauth_shared_secret
string
visibility
ResourceVisibility
owned
boolean
configuration
object
analytics_service_url
string
webhook_url
string
webhook_state
string
configured_gateway_service_urls
array
org_url
string
availability_zone_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Portal Service objects
GET /orgs/{org}/portal-services
List the Portal Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Portal Service object by name or id
GET /orgs/{org}/portal-services/{portal-service}
Get the Portal Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
web_endpoint_base
string
endpoint
string
endpoint_tls_client_profile_url
string
visibility
ResourceVisibility
owned
boolean
webhook_url
string
webhook_state
string
catalog_setting_urls
array
org_url
string
availability_zone_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Oauth Provider object
POST /orgs/{org}/oauth-providers
Create a Oauth Provider object
Request
Request Body
OauthProvider
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
enabled
boolean
override_endpoint_from_api
boolean
default_validator_endpoint
object
request_query
string
request_headers_regex
string
response_headers_regex
string
native_provider
object
api
object
default_scopes
string
authorize_path
string
token_path
string
token_secret
object
clients
array
access_code_ttl
integer
access_token_ttl
integer
access_token_one_time_use
boolean
maximum_consent_ttl
integer
refresh_token
object
revocation
object
token_introspection
object
token_metadata
object
openid_connect
object
pkce
object
advanced_scope_security
object
native_provider_5000
object
third_party_config
object
token_validation_requirement
string
authorize_endpoint
string
token_endpoint
string
introspection_endpoint
object
security
array
basic_auth
object
custom_headername_format
string
advanced_scope_security
object
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
visibility
ResourceVisibility
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Oauth Provider objects
GET /orgs/{org}/oauth-providers
List the Oauth Provider objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Oauth Provider objects
DELETE /orgs/{org}/oauth-providers
Clear the Oauth Provider objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Oauth Provider object by name or id
GET /orgs/{org}/oauth-providers/{oauth-provider}
Get the Oauth Provider object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
visibility
ResourceVisibility
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Oauth Provider object by name or id
PATCH /orgs/{org}/oauth-providers/{oauth-provider}
Update the Oauth Provider object by name or id
Request
Request Body
OauthProvider
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
enabled
boolean
override_endpoint_from_api
boolean
default_validator_endpoint
object
request_query
string
request_headers_regex
string
response_headers_regex
string
native_provider
object
api
object
default_scopes
string
authorize_path
string
token_path
string
token_secret
object
clients
array
access_code_ttl
integer
access_token_ttl
integer
access_token_one_time_use
boolean
maximum_consent_ttl
integer
refresh_token
object
revocation
object
token_introspection
object
token_metadata
object
openid_connect
object
pkce
object
advanced_scope_security
object
native_provider_5000
object
third_party_config
object
token_validation_requirement
string
authorize_endpoint
string
token_endpoint
string
introspection_endpoint
object
security
array
basic_auth
object
custom_headername_format
string
advanced_scope_security
object
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
visibility
ResourceVisibility
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Oauth Provider object by name or id
DELETE /orgs/{org}/oauth-providers/{oauth-provider}
Delete the Oauth Provider object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
debug
boolean
owned
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
visibility
ResourceVisibility
user_registry_urls
array
tls_client_profile_urls
array
configured_oauth_provider_urls
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Billing object
POST /orgs/{org}/billings
Create a Billing object
Request
Request Body
Billing
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Billing objects
GET /orgs/{org}/billings
List the Billing objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Billing objects
DELETE /orgs/{org}/billings
Clear the Billing objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Billing object by name or id
GET /orgs/{org}/billings/{billing}
Get the Billing object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Billing object by name or id
PATCH /orgs/{org}/billings/{billing}
Update the Billing object by name or id
Request
Request Body
Billing
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Billing object by name or id
DELETE /orgs/{org}/billings/{billing}
Delete the Billing object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
configuration
object
visibility
ResourceVisibility
owned
boolean
configured_billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Job objects
GET /orgs/{org}/billings/{billing}/jobs
List the Job objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Job objects
DELETE /orgs/{org}/billings/{billing}/jobs
Clear the Job objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Job object by name or id
GET /orgs/{org}/billings/{billing}/jobs/{job}
Get the Job object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
activity
array
path
string
body
object
generated_at
string
processed_work
integer
processed_at
string
retries
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Job object by name or id
DELETE /orgs/{org}/billings/{billing}/jobs/{job}
Delete the Job object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
activity
array
path
string
body
object
generated_at
string
processed_work
integer
processed_at
string
retries
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Re-attempt blocked or failed job
POST /orgs/{org}/billings/{billing}/jobs/{job}/retry
Re-attempt blocked or failed job
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
200 - Success
default -
Create a TLS Client Profile object
POST /orgs/{org}/tls-client-profiles
Create a TLS Client Profile object
Request
Request Body
TLSClientProfile
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List all TLS Client Profile objects in all collections
GET /orgs/{org}/tls-client-profiles
List all TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all TLS Client Profile objects in all collections
DELETE /orgs/{org}/tls-client-profiles
Clear all TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
cascade
boolean
Cascade the behavior
Response
204 - Success
default -
List the TLS Client Profile objects
GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}
List the TLS Client Profile objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the TLS Client Profile objects
DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}
Clear the TLS Client Profile objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the TLS Client Profile object by id
GET /orgs/{org}/tls-client-profiles/{tls-client-profile-id}
Get the TLS Client Profile object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the TLS Client Profile object by id
PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-id}
Update the TLS Client Profile object by id
Request
Request Body
TLSClientProfile
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the TLS Client Profile object by id
DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-id}
Delete the TLS Client Profile object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the TLS Client Profile object by name and version
GET /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Get the TLS Client Profile object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the TLS Client Profile object by name and version
PATCH /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Update the TLS Client Profile object by name and version
Request
Request Body
TLSClientProfile
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
type
string
group_urls
array
org_urls
array
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a TLS Client Profile
DELETE /orgs/{org}/tls-client-profiles/{tls-client-profile-name}/{tls-client-profile-version}
Delete a TLS Client Profile
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
owned
boolean
keystore_url
string
truststore_url
string
webhook_urls
array
visibility
ResourceVisibility
configured_tls_client_profile_urls
array
oauth_provider_urls
array
configured_oauth_provider_urls
array
mail_server_urls
array
gateway_service_urls
array
portal_service_urls
array
analytics_service_urls
array
org_url
string
cloud_setting_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Keystore object
POST /orgs/{org}/keystores
Create a Keystore object
Request
Request Body
Keystore
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
pem
string
certificate_info
string
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Keystore objects
GET /orgs/{org}/keystores
List the Keystore objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Keystore objects
DELETE /orgs/{org}/keystores
Clear the Keystore objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Keystore object by name or id
GET /orgs/{org}/keystores/{keystore}
Get the Keystore object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Keystore object by name or id
PATCH /orgs/{org}/keystores/{keystore}
Update the Keystore object by name or id
Request
Request Body
Keystore
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
pem
string
certificate_info
string
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Keystore object by name or id
DELETE /orgs/{org}/keystores/{keystore}
Delete the Keystore object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
private_key_entry
string
public_certificate_entry
CertEntry
trusted_certificate_entries
array
keystore
string
password
string
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Truststore object
POST /orgs/{org}/truststores
Create a Truststore object
Request
Request Body
Truststore
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Truststore objects
GET /orgs/{org}/truststores
List the Truststore objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Truststore objects
DELETE /orgs/{org}/truststores
Clear the Truststore objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Truststore object by name or id
GET /orgs/{org}/truststores/{truststore}
Get the Truststore object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Truststore object by name or id
PATCH /orgs/{org}/truststores/{truststore}
Update the Truststore object by name or id
Request
Request Body
Truststore
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Truststore object by name or id
DELETE /orgs/{org}/truststores/{truststore}
Delete the Truststore object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
truststore
string
password
string
entry_urls
array
tls_server_profile_urls
array
tls_client_profile_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Entry object
POST /orgs/{org}/truststores/{truststore}/entries
Create a Entry object
Request
Request Body
Entry
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Entry objects
GET /orgs/{org}/truststores/{truststore}/entries
List the Entry objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Entry objects
DELETE /orgs/{org}/truststores/{truststore}/entries
Clear the Entry objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Entry object by name or id
GET /orgs/{org}/truststores/{truststore}/entries/{entry}
Get the Entry object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Entry object by name or id
PATCH /orgs/{org}/truststores/{truststore}/entries/{entry}
Update the Entry object by name or id
Request
Request Body
Entry
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Entry object by name or id
DELETE /orgs/{org}/truststores/{truststore}/entries/{entry}
Delete the Entry object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
entry_type
string
pem
string
certificate_info
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Catalog Setting object
GET /catalogs/{org}/{catalog}/settings
Get the Catalog Setting object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
user_registry_default_url
string
production_mode
boolean
portal
object
product_lifecycle_approvals
array
task_self_approval
boolean
application_lifecycle
object
consumer_self_service_onboarding
boolean
invitation_ttl
integer
legacy_endpoint_behavior
string
v5_endpoint_substitution_behavior
object
vanity_api_endpoint
object
spaces_enabled
boolean
custom_notification_templates_enabled
boolean
email_sender
EmailSender
hash_client_secret
boolean
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Catalog Setting object
PUT /catalogs/{org}/{catalog}/settings
Update the Catalog Setting object
Request
Request Body
CatalogSetting
type
string
api_version
string
name
string
title
string
summary
string
user_registry_default_url
string
production_mode
boolean
portal
object
type
string
endpoint
string
portal_service_url
string
webhook_url
string
webhook_state
string
product_lifecycle_approvals
array
task_self_approval
boolean
application_lifecycle
object
enabled
boolean
consumer_self_service_onboarding
boolean
invitation_ttl
integer
legacy_endpoint_behavior
string
v5_endpoint_substitution_behavior
object
base_endpoints
array
unenforced_api_base_endpoint
string
vanity_api_endpoint
object
enabled
boolean
endpoint_preference
string
vanity_api_base_endpoints
array
spaces_enabled
boolean
custom_notification_templates_enabled
boolean
email_sender
EmailSender
custom
boolean
name
string
address
string
hash_client_secret
boolean
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
user_registry_default_url
string
production_mode
boolean
portal
object
product_lifecycle_approvals
array
task_self_approval
boolean
application_lifecycle
object
consumer_self_service_onboarding
boolean
invitation_ttl
integer
legacy_endpoint_behavior
string
v5_endpoint_substitution_behavior
object
vanity_api_endpoint
object
spaces_enabled
boolean
custom_notification_templates_enabled
boolean
email_sender
EmailSender
hash_client_secret
boolean
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Gateway Service object
POST /catalogs/{org}/{catalog}/configured-gateway-services
Create a Configured Gateway Service object
Request
Request Body
ConfiguredGatewayService
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
service_state
string
service_up_to_date
boolean
last_processed_event
object
number_of_outstanding_sent_events
integer
last_sent_event
object
number_of_outstanding_queued_events
integer
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Gateway Service objects
GET /catalogs/{org}/{catalog}/configured-gateway-services
List the Configured Gateway Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Gateway Service objects
DELETE /catalogs/{org}/{catalog}/configured-gateway-services
Clear the Configured Gateway Service objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Gateway Service object by name or id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}
Get the Configured Gateway Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Gateway Service object by name or id
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}
Delete the Configured Gateway Service object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Gateway Service object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services
Create a Configured Gateway Service object
Request
Request Body
ConfiguredGatewayService
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
service_state
string
service_up_to_date
boolean
last_processed_event
object
number_of_outstanding_sent_events
integer
last_sent_event
object
number_of_outstanding_queued_events
integer
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Gateway Service objects
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services
List the Configured Gateway Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Gateway Service objects
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services
Clear the Configured Gateway Service objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Gateway Service object by name or id
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}
Get the Configured Gateway Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Gateway Service object by name or id
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}
Delete the Configured Gateway Service object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
gateway_service_url
string
integration_url
string
gateway_service_type
string
owned
boolean
configuration
object
availability_zone_url
string
endpoint
string
api_endpoint_base
string
catalog_base
string
sni
array
oauth_shared_secret
string
tls_client_profile_url
string
analytics_service_url
string
gateway_version
string
domain_name
string
managed_by
string
product_urls
array
configured_oauth_provider_urls
array
api_urls
array
webhook_url
string
catalog_webhook_url
string
webhook_state
string
catalog_webhook_state
string
space_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_processing_status
SubscriberProcessingStatus
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Catalog User Registry object
POST /catalogs/{org}/{catalog}/configured-catalog-user-registries
Create a Configured Catalog User Registry object
Request
Request Body
ConfiguredCatalogUserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
endpoint
Required *
string
tls_client_profile_url
string
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Catalog User Registry objects
GET /catalogs/{org}/{catalog}/configured-catalog-user-registries
List the Configured Catalog User Registry objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Configured Catalog User Registry object by name or id
GET /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}
Get the Configured Catalog User Registry object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Catalog User Registry object by name or id
DELETE /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}
Delete the Configured Catalog User Registry object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Search for users in the catalog user registry
POST /catalogs/{org}/{catalog}/configured-catalog-user-registries/{configured-catalog-user-registry}/search
Search for users in the catalog user registry
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Create a Configured API User Registry object
POST /catalogs/{org}/{catalog}/configured-api-user-registries
Create a Configured API User Registry object
Request
Request Body
ConfiguredAPIUserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
endpoint
Required *
string
tls_client_profile_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured API User Registry objects
GET /catalogs/{org}/{catalog}/configured-api-user-registries
List the Configured API User Registry objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured API User Registry objects
DELETE /catalogs/{org}/{catalog}/configured-api-user-registries
Clear the Configured API User Registry objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured API User Registry object by name or id
GET /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}
Get the Configured API User Registry object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured API User Registry object by name or id
DELETE /catalogs/{org}/{catalog}/configured-api-user-registries/{configured-api-user-registry}
Delete the Configured API User Registry object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured API User Registry object
POST /spaces/{org}/{catalog}/{space}/configured-api-user-registries
Create a Configured API User Registry object
Request
Request Body
ConfiguredAPIUserRegistry
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
endpoint
Required *
string
tls_client_profile_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured API User Registry objects
GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries
List the Configured API User Registry objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured API User Registry objects
DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries
Clear the Configured API User Registry objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured API User Registry object by name or id
GET /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}
Get the Configured API User Registry object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured API User Registry object by name or id
DELETE /spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}
Delete the Configured API User Registry object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
user_registry_url
string
owned
boolean
integration_url
string
registry_type
string
user_managed
boolean
user_registry_managed
boolean
onboarding
string
case_sensitive
boolean
identity_providers
array
configuration
object
endpoint
SecuredEndpoint
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured TLS Client Profile object
POST /catalogs/{org}/{catalog}/configured-tls-client-profiles
Create a Configured TLS Client Profile object
Request
Request Body
ConfiguredTLSClientProfile
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Configured TLS Client Profile objects in all collections
GET /catalogs/{org}/{catalog}/configured-tls-client-profiles
List all Configured TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Configured TLS Client Profile objects in all collections
DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles
Clear all Configured TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Configured TLS Client Profile objects
GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}
List the Configured TLS Client Profile objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured TLS Client Profile objects
DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}
Clear the Configured TLS Client Profile objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured TLS Client Profile object by id
GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Get the Configured TLS Client Profile object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured TLS Client Profile object by id
DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Delete the Configured TLS Client Profile object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Configured TLS Client Profile object by name and version
GET /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Get the Configured TLS Client Profile object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Configured TLS Client Profile
DELETE /catalogs/{org}/{catalog}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Delete a Configured TLS Client Profile
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured TLS Client Profile object
POST /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles
Create a Configured TLS Client Profile object
Request
Request Body
ConfiguredTLSClientProfile
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Configured TLS Client Profile objects in all collections
GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles
List all Configured TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Configured TLS Client Profile objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles
Clear all Configured TLS Client Profile objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Configured TLS Client Profile objects
GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}
List the Configured TLS Client Profile objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured TLS Client Profile objects
DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}
Clear the Configured TLS Client Profile objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured TLS Client Profile object by id
GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Get the Configured TLS Client Profile object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured TLS Client Profile object by id
DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}
Delete the Configured TLS Client Profile object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Configured TLS Client Profile object by name and version
GET /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Get the Configured TLS Client Profile object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Configured TLS Client Profile
DELETE /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
Delete a Configured TLS Client Profile
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
tls_client_profile_url
string
owned
boolean
protocols
array
ciphers
array
elliptic_curve_auto_negotiation
boolean
elliptic_curve
array
insecure_server_connections
boolean
server_name_indication
boolean
keystore_url
string
truststore_url
string
api_urls
array
global_policy_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Billing object
POST /catalogs/{org}/{catalog}/configured-billings
Create a Configured Billing object
Request
Request Body
ConfiguredBilling
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Billing objects
GET /catalogs/{org}/{catalog}/configured-billings
List the Configured Billing objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Billing objects
DELETE /catalogs/{org}/{catalog}/configured-billings
Clear the Configured Billing objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Billing object by name or id
GET /catalogs/{org}/{catalog}/configured-billings/{configured-billing}
Get the Configured Billing object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Billing object by name or id
DELETE /catalogs/{org}/{catalog}/configured-billings/{configured-billing}
Delete the Configured Billing object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Billing object
POST /spaces/{org}/{catalog}/{space}/configured-billings
Create a Configured Billing object
Request
Request Body
ConfiguredBilling
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Billing objects
GET /spaces/{org}/{catalog}/{space}/configured-billings
List the Configured Billing objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Billing objects
DELETE /spaces/{org}/{catalog}/{space}/configured-billings
Clear the Configured Billing objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Billing object by name or id
GET /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}
Get the Configured Billing object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Billing object by name or id
DELETE /spaces/{org}/{catalog}/{space}/configured-billings/{configured-billing}
Delete the Configured Billing object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
billing_url
string
owned
boolean
integration_url
string
configuration
object
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Oauth Provider object
POST /catalogs/{org}/{catalog}/configured-oauth-providers
Create a Configured Oauth Provider object
Request
Request Body
ConfiguredOauthProvider
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
enabled
boolean
override_endpoint_from_api
boolean
default_validator_endpoint
object
request_query
string
request_headers_regex
string
response_headers_regex
string
native_provider
object
api
object
default_scopes
string
authorize_path
string
token_path
string
token_secret
object
clients
array
access_code_ttl
integer
access_token_ttl
integer
access_token_one_time_use
boolean
maximum_consent_ttl
integer
refresh_token
object
revocation
object
token_introspection
object
token_metadata
object
openid_connect
object
pkce
object
advanced_scope_security
object
native_provider_5000
object
third_party_config
object
token_validation_requirement
string
authorize_endpoint
string
token_endpoint
string
introspection_endpoint
object
security
array
basic_auth
object
custom_headername_format
string
advanced_scope_security
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Oauth Provider objects
GET /catalogs/{org}/{catalog}/configured-oauth-providers
List the Configured Oauth Provider objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Oauth Provider objects
DELETE /catalogs/{org}/{catalog}/configured-oauth-providers
Clear the Configured Oauth Provider objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Oauth Provider object by name or id
GET /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}
Get the Configured Oauth Provider object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Oauth Provider object by name or id
DELETE /catalogs/{org}/{catalog}/configured-oauth-providers/{configured-oauth-provider}
Delete the Configured Oauth Provider object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Configured Oauth Provider object
POST /spaces/{org}/{catalog}/{space}/configured-oauth-providers
Create a Configured Oauth Provider object
Request
Request Body
ConfiguredOauthProvider
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
enabled
boolean
override_endpoint_from_api
boolean
default_validator_endpoint
object
request_query
string
request_headers_regex
string
response_headers_regex
string
native_provider
object
api
object
default_scopes
string
authorize_path
string
token_path
string
token_secret
object
clients
array
access_code_ttl
integer
access_token_ttl
integer
access_token_one_time_use
boolean
maximum_consent_ttl
integer
refresh_token
object
revocation
object
token_introspection
object
token_metadata
object
openid_connect
object
pkce
object
advanced_scope_security
object
native_provider_5000
object
third_party_config
object
token_validation_requirement
string
authorize_endpoint
string
token_endpoint
string
introspection_endpoint
object
security
array
basic_auth
object
custom_headername_format
string
advanced_scope_security
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Configured Oauth Provider objects
GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers
List the Configured Oauth Provider objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Configured Oauth Provider objects
DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers
Clear the Configured Oauth Provider objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configured Oauth Provider object by name or id
GET /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}
Get the Configured Oauth Provider object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Configured Oauth Provider object by name or id
DELETE /spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}
Delete the Configured Oauth Provider object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
oauth_provider_url
string
owned
boolean
debug
boolean
provider_type
string
scopes
object
grants
array
gateway_version
string
advanced_scope
object
native_provider
object
third_party_config
object
user_registry_urls
array
tls_client_profile_urls
array
configured_gateway_service_urls
array
api_urls
array
product_urls
array
space_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Notification Template objects in all collections
GET /catalogs/{org}/{catalog}/settings/notification-templates
List all Notification Template objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Notification Template objects
GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /catalogs/{org}/{catalog}/settings/notification-templates/catalog/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /catalogs/{org}/{catalog}/settings/notification-templates/space
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /catalogs/{org}/{catalog}/settings/notification-templates/space/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /catalogs/{org}/{catalog}/settings/notification-templates/consumer/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Role Default objects in all collections
GET /catalogs/{org}/{catalog}/role-defaults
List all Role Default objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Create a Role Default object
POST /catalogs/{org}/{catalog}/role-defaults/consumer
Create a Role Default object
Request
Request Body
RoleDefault
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role Default objects
GET /catalogs/{org}/{catalog}/role-defaults/consumer
List the Role Default objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Role Default objects
DELETE /catalogs/{org}/{catalog}/role-defaults/consumer
Clear the Role Default objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Role Default object by name or id
GET /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}
Get the Role Default object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role Default object by name or id
PATCH /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}
Update the Role Default object by name or id
Request
Request Body
RoleDefault
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Role Default object by name or id
DELETE /catalogs/{org}/{catalog}/role-defaults/consumer/{role-default}
Delete the Role Default object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Augment the Configuration Property with additional name/value pairs
PATCH /catalogs/{org}/{catalog}/properties
Augment the Configuration Property with additional name/value pairs
Request
Request Body
NameValuePairs
Response
200 - Successful create
default -
List the Configuration Property objects
GET /catalogs/{org}/{catalog}/properties
List the Configuration Property objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
default -
Clear the Configuration Property objects
DELETE /catalogs/{org}/{catalog}/properties
Clear the Configuration Property objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Configuration Property object
GET /catalogs/{org}/{catalog}/properties/{property-name}
Get the Configuration Property object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
default -
Update the Configuration Property object
PATCH /catalogs/{org}/{catalog}/properties/{property-name}
Update the Configuration Property object
Request
Request Body
Property
Response
200 - Success
default -
Delete the Configuration Property object
DELETE /catalogs/{org}/{catalog}/properties/{property-name}
Delete the Configuration Property object
Request
Response
200 - Successful delete
default -
Create a Catalog object
POST /orgs/{org}/catalogs
Create a Catalog object
Request
Request Body
Catalog
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Catalog objects
GET /orgs/{org}/catalogs
List the Catalog objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Catalog objects
DELETE /orgs/{org}/catalogs
Clear the Catalog objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Catalog object by name or id
GET /catalogs/{org}/{catalog}
Get the Catalog object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Catalog object by name or id
PATCH /catalogs/{org}/{catalog}
Update the Catalog object by name or id
Request
Request Body
Catalog
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Catalog object by name or id
DELETE /catalogs/{org}/{catalog}
Delete the Catalog object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Transfer owner to an associate
POST /catalogs/{org}/{catalog}/transfer-owner
Transfer owner to an associate
Request
Request Body
TransferOwner
new_owner_associate_url
string
new_owner_member_url
string
old_owner_new_role_urls
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
configured_catalog_user_registry_urls
array
org_url
string
app_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Send email
POST /catalogs/{org}/{catalog}/send-email
Send email
Request
Request Body
SendEmail
from
string
to
string
cc
string
bcc
string
subject
string
body
string
content_type
string
Response
204 - Success
400 - Failure
default -
Search for users in the catalog realm
POST /catalogs/{org}/{catalog}/search/user
Search for users in the catalog realm
Request
Request Body
UserSearch
username
string
remote
boolean
Path Parameters
Query Parameters
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Stage a draft product
POST /catalogs/{org}/{catalog}/stage-draft-product
Stage a draft product
Request
Request Body
DraftProductPublish
gateway_service_urls
array
draft_product_url
Required *
string
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Publish a draft product
POST /catalogs/{org}/{catalog}/publish-draft-product
Publish a draft product
Request
Request Body
DraftProductPublish
gateway_service_urls
array
draft_product_url
Required *
string
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Stage the product
POST /catalogs/{org}/{catalog}/stage
Stage the product
Request
Request Body
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Publish the product
POST /catalogs/{org}/{catalog}/publish
Publish the product
Request
Request Body
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Catalog Invitation object
POST /orgs/{org}/catalog-invitations
Create a Catalog Invitation object
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Catalog Invitation objects
GET /orgs/{org}/catalog-invitations
List the Catalog Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Catalog Invitation objects
DELETE /orgs/{org}/catalog-invitations
Clear the Catalog Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Catalog Invitation object by name or id
GET /orgs/{org}/catalog-invitations/{invitation}
Get the Catalog Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Catalog Invitation object by name or id
PATCH /orgs/{org}/catalog-invitations/{invitation}
Update the Catalog Invitation object by name or id
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Catalog Invitation object by name or id
DELETE /orgs/{org}/catalog-invitations/{invitation}
Delete the Catalog Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Catalog Invitation
POST /orgs/{org}/catalog-invitations/{invitation}/regenerate
Regenerate the Catalog Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Register using the Catalog Invitation
POST /orgs/{org}/catalog-invitations/{invitation}/register
Register using the Catalog Invitation
Request
Request Body
InvitationRegister
client_id
string
client_secret
string
user
object
realm
string
username
string
password
string
string
first_name
string
last_name
string
org
object
name
string
title
string
summary
string
catalog
object
name
string
title
string
summary
string
space
object
name
string
title
string
summary
string
consumer_org
object
name
string
title
string
summary
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Accept using the Catalog Invitation
POST /orgs/{org}/catalog-invitations/{invitation}/accept
Accept using the Catalog Invitation
Request
Request Body
InvitationAccept
client_id
string
client_secret
string
user
object
realm
string
username
string
password
string
token
string
token_secret
string
org
object
name
string
title
string
summary
string
catalog
object
name
string
title
string
summary
string
space
object
name
string
title
string
summary
string
consumer_org
object
name
string
title
string
summary
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Create a Member Invitation object
POST /catalogs/{org}/{catalog}/member-invitations
Create a Member Invitation object
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member Invitation objects
GET /catalogs/{org}/{catalog}/member-invitations
List the Member Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member Invitation objects
DELETE /catalogs/{org}/{catalog}/member-invitations
Clear the Member Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member Invitation object by name or id
GET /catalogs/{org}/{catalog}/member-invitations/{member-invitation}
Get the Member Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member Invitation object by name or id
PATCH /catalogs/{org}/{catalog}/member-invitations/{member-invitation}
Update the Member Invitation object by name or id
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member Invitation object by name or id
DELETE /catalogs/{org}/{catalog}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Member Invitation
POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/regenerate
Regenerate the Member Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Register using the Member Invitation
POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/register
Register using the Member Invitation
Request
Request Body
MemberInvitationRegister
client_id
string
client_secret
string
realm
string
username
string
password
string
string
first_name
string
last_name
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Accept using the Member Invitation
POST /catalogs/{org}/{catalog}/member-invitations/{member-invitation}/accept
Accept using the Member Invitation
Request
Request Body
MemberInvitationAccept
client_id
string
client_secret
string
realm
string
username
string
password
string
token
string
token_secret
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Create a Member object
POST /catalogs/{org}/{catalog}/members
Create a Member object
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member objects
GET /catalogs/{org}/{catalog}/members
List the Member objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member objects
DELETE /catalogs/{org}/{catalog}/members
Clear the Member objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member object by name or id
GET /catalogs/{org}/{catalog}/members/{member}
Get the Member object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member object by name or id
PATCH /catalogs/{org}/{catalog}/members/{member}
Update the Member object by name or id
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member object by name or id
DELETE /catalogs/{org}/{catalog}/members/{member}
Delete the Member object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Task objects
GET /catalogs/{org}/{catalog}/tasks
List the Task objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Task object by name or id
GET /catalogs/{org}/{catalog}/tasks/{task}
Get the Task object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Task object by name or id
PATCH /catalogs/{org}/{catalog}/tasks/{task}
Update the Task object by name or id
Request
Request Body
Task
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role objects
GET /catalogs/{org}/{catalog}/roles
List the Role objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Role object by name or id
GET /catalogs/{org}/{catalog}/roles/{role}
Get the Role object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role object by name or id
PATCH /catalogs/{org}/{catalog}/roles/{role}
Update the Role object by name or id
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Global Policy object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies
Create a Global Policy object
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Global Policy objects in all collections
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies
List all Global Policy objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Global Policy objects in all collections
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies
Clear all Global Policy objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Global Policy objects
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}
List the Global Policy objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Global Policy objects
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}
Clear the Global Policy objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Global Policy object by id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Get the Global Policy object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy object by id
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Update the Global Policy object by id
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy object by id
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Delete the Global Policy object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy object by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Get the Global Policy object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy object by name and version
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Update the Global Policy object by name and version
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Global Policy
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Delete a Global Policy
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy document
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document
Get the Global Policy document
Request
Response
200 - Success
default -
Get the Global Policy document by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document
Get the Global Policy document by name and version
Request
Response
200 - Success
default -
Create a Global Policy object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies
Create a Global Policy object
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Global Policy objects in all collections
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies
List all Global Policy objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Global Policy objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies
Clear all Global Policy objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Global Policy objects
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}
List the Global Policy objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Global Policy objects
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}
Clear the Global Policy objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Global Policy object by id
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Get the Global Policy object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy object by id
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Update the Global Policy object by id
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy object by id
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}
Delete the Global Policy object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy object by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Get the Global Policy object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy object by name and version
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Update the Global Policy object by name and version
Request
Request Body
GlobalPolicy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Global Policy
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}
Delete a Global Policy
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
global_policy
GlobalPolicyDocument
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
global_policy_prehook_urls
array
global_policy_posthook_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy document
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-id}/document
Get the Global Policy document
Request
Response
200 - Success
default -
Get the Global Policy document by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policies/{global-policy-name}/{global-policy-version}/document
Get the Global Policy document by name and version
Request
Response
200 - Success
default -
Create a Policy object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies
Create a Policy object
Request
Request Body
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Policy objects in all collections
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies
List all Policy objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Policy objects in all collections
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies
Clear all Policy objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Policy objects
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}
List the Policy objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Policy objects
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}
Clear the Policy objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Policy object by id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Get the Policy object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Policy object by id
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Update the Policy object by id
Request
Request Body
Policy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
content_type
Required *
string
content
Required *
string
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Policy object by id
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Delete the Policy object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Policy object by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Get the Policy object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Policy object by name and version
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Update the Policy object by name and version
Request
Request Body
Policy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
content_type
Required *
string
content
Required *
string
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Policy
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Delete a Policy
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Policy document
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document
Get the Policy document
Request
Response
200 - Success
default -
Get the Policy document by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document
Get the Policy document by name and version
Request
Response
200 - Success
default -
Get the Policy implementation document
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation
Get the Policy implementation document
Request
Response
200 - Success
default -
Get the Policy implementation document by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation
Get the Policy implementation document by name and version
Request
Response
200 - Success
default -
Create a Policy object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies
Create a Policy object
Request
Request Body
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Policy objects in all collections
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies
List all Policy objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Policy objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies
Clear all Policy objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Policy objects
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}
List the Policy objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Policy objects
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}
Clear the Policy objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Policy object by id
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Get the Policy object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Policy object by id
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Update the Policy object by id
Request
Request Body
Policy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
content_type
Required *
string
content
Required *
string
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Policy object by id
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}
Delete the Policy object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Policy object by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Get the Policy object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Policy object by name and version
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Update the Policy object by name and version
Request
Request Body
Policy
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
content_type
Required *
string
content
Required *
string
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Policy
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}
Delete a Policy
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
custom
boolean
policy
PolicyDocument
implementation
object
api_urls
array
global_policy_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Policy document
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/document
Get the Policy document
Request
Response
200 - Success
default -
Get the Policy document by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/document
Get the Policy document by name and version
Request
Response
200 - Success
default -
Get the Policy implementation document
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-id}/implementation
Get the Policy implementation document
Request
Response
200 - Success
default -
Get the Policy implementation document by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/policies/{policy-name}/{policy-version}/implementation
Get the Policy implementation document by name and version
Request
Response
200 - Success
default -
Create a Extension object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions
Create a Extension object
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Extension objects in all collections
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions
List all Extension objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Extension objects in all collections
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions
Clear all Extension objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Extension objects
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}
List the Extension objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Extension objects
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}
Clear the Extension objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Extension object by id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Get the Extension object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Extension object by id
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Update the Extension object by id
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Extension object by id
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Delete the Extension object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Extension object by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Get the Extension object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Extension object by name and version
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Update the Extension object by name and version
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Extension
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Delete a Extension
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Extension document
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document
Get the Extension document
Request
Response
200 - Success
extension
string
info
InfoSection
properties
object
default -
Get the Extension document by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document
Get the Extension document by name and version
Request
Response
200 - Success
extension
string
info
InfoSection
properties
object
default -
Create a Extension object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions
Create a Extension object
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Extension objects in all collections
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions
List all Extension objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Extension objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions
Clear all Extension objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Extension objects
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}
List the Extension objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Extension objects
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}
Clear the Extension objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Extension object by id
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Get the Extension object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Extension object by id
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Update the Extension object by id
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Extension object by id
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}
Delete the Extension object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Extension object by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Get the Extension object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Extension object by name and version
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Update the Extension object by name and version
Request
Request Body
Extension
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
extension
Required *
string
info
Required *
object
properties
object
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Extension
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}
Delete a Extension
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
extension
ExtensionDocument
api_urls
array
org_url
string
catalog_url
string
space_url
string
gateway_service_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Extension document
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-id}/document
Get the Extension document
Request
Response
200 - Success
extension
string
info
InfoSection
properties
object
default -
Get the Extension document by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/extensions/{extension-name}/{extension-version}/document
Get the Extension document by name and version
Request
Response
200 - Success
extension
string
info
InfoSection
properties
object
default -
Create a Service object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services
Create a Service object
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Service objects in all collections
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services
List all Service objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Service objects in all collections
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services
Clear all Service objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Service objects
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}
List the Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Service objects
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}
Clear the Service objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Service object by id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Get the Service object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Service object by id
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Update the Service object by id
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Service object by id
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Delete the Service object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Service object by name and version
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Get the Service object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Service object by name and version
PATCH /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Update the Service object by name and version
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Service
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Delete a Service
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Service object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services
Create a Service object
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Service objects in all collections
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services
List all Service objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Service objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services
Clear all Service objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Service objects
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}
List the Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Service objects
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}
Clear the Service objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Service object by id
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Get the Service object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Service object by id
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Update the Service object by id
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Service object by id
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-id}
Delete the Service object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Service object by name and version
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Get the Service object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Service object by name and version
PATCH /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Update the Service object by name and version
Request
Request Body
Service
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
endpoint
string
tls_client_profile_url
string
timeout
integer
username
string
password
string
http_method
string
compression
boolean
org_url
string
catalog_url
string
space_url
string
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Service
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/services/{service-name}/{service-version}
Delete a Service
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
service
object
service_schema
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Create the Global Policy Prehook object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Create the Global Policy Prehook object
Request
Request Body
GlobalPolicyPrehook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy Prehook object
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Get the Global Policy Prehook object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy Prehook object
PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Update the Global Policy Prehook object
Request
Request Body
GlobalPolicyPrehook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy Prehook object
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Delete the Global Policy Prehook object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create the Global Policy Prehook object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Create the Global Policy Prehook object
Request
Request Body
GlobalPolicyPrehook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy Prehook object
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Get the Global Policy Prehook object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy Prehook object
PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Update the Global Policy Prehook object
Request
Request Body
GlobalPolicyPrehook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy Prehook object
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-prehook
Delete the Global Policy Prehook object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create the Global Policy Posthook object
POST /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Create the Global Policy Posthook object
Request
Request Body
GlobalPolicyPosthook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy Posthook object
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Get the Global Policy Posthook object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy Posthook object
PUT /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Update the Global Policy Posthook object
Request
Request Body
GlobalPolicyPosthook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy Posthook object
DELETE /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Delete the Global Policy Posthook object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create the Global Policy Posthook object
POST /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Create the Global Policy Posthook object
Request
Request Body
GlobalPolicyPosthook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Global Policy Posthook object
GET /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Get the Global Policy Posthook object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Global Policy Posthook object
PUT /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Update the Global Policy Posthook object
Request
Request Body
GlobalPolicyPosthook
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Global Policy Posthook object
DELETE /spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/global-policy-posthook
Delete the Global Policy Posthook object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
scope
string
global_policy_url
string
user_registry_urls
array
tls_client_profile_urls
array
policy_urls
array
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Analytics Service objects
GET /catalogs/{org}/{catalog}/analytics-services
List the Analytics Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Analytics Service object by name or id
GET /catalogs/{org}/{catalog}/analytics-services/{analytics-service}
Get the Analytics Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
query
string
Add query to request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
endpoint
string
ingestion_endpoint
string
ingestion_endpoint_tls_client_profile_url
string
client_endpoint
string
client_endpoint_tls_client_profile_url
string
gateway_service_urls
array
org_url
string
availability_zone_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create an Analytics object
POST /catalogs/{org}/{catalog}/analytics-services/{analytics-service}/analytics
Create an Analytics object
Request
Request Body
Analytics
Path Parameters
Query Parameters
query
string
Add query to request
Response
201 - Successful create
default -
List the Analytics Service objects
GET /spaces/{org}/{catalog}/{space}/analytics-services
List the Analytics Service objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Analytics Service object by name or id
GET /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}
Get the Analytics Service object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
query
string
Add query to request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
endpoint
string
ingestion_endpoint
string
ingestion_endpoint_tls_client_profile_url
string
client_endpoint
string
client_endpoint_tls_client_profile_url
string
gateway_service_urls
array
org_url
string
availability_zone_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create an Analytics object
POST /spaces/{org}/{catalog}/{space}/analytics-services/{analytics-service}/analytics
Create an Analytics object
Request
Request Body
Analytics
Path Parameters
Query Parameters
query
string
Add query to request
Response
201 - Successful create
default -
Get the Space Setting object
GET /spaces/{org}/{catalog}/{space}/settings
Get the Space Setting object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Space Setting object
PUT /spaces/{org}/{catalog}/{space}/settings
Update the Space Setting object
Request
Request Body
SpaceSetting
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
custom
boolean
name
string
address
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
custom_notification_templates_enabled
boolean
email_sender
EmailSender
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Notification Template objects in all collections
GET /spaces/{org}/{catalog}/{space}/settings/notification-templates
List all Notification Template objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Notification Template objects
GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Notification Template objects
GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer
List the Notification Template objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Notification Template object by name or id
GET /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}
Get the Notification Template object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Notification Template object by name or id
PATCH /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}
Update the Notification Template object by name or id
Request
Request Body
NotificationTemplate
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
notification_template_type
string
title
string
summary
string
scope
string
variables
array
subject
string
body
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Role Default objects in all collections
GET /spaces/{org}/{catalog}/{space}/role-defaults
List all Role Default objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Create a Role Default object
POST /spaces/{org}/{catalog}/{space}/role-defaults/consumer
Create a Role Default object
Request
Request Body
RoleDefault
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role Default objects
GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer
List the Role Default objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Role Default objects
DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer
Clear the Role Default objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Role Default object by name or id
GET /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}
Get the Role Default object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role Default object by name or id
PATCH /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}
Update the Role Default object by name or id
Request
Request Body
RoleDefault
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Role Default object by name or id
DELETE /spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}
Delete the Role Default object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
role_default_type
string
title
string
summary
string
scope
string
permission_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Space object
POST /catalogs/{org}/{catalog}/spaces
Create a Space object
Request
Request Body
Space
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Space objects
GET /catalogs/{org}/{catalog}/spaces
List the Space objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Space objects
DELETE /catalogs/{org}/{catalog}/spaces
Clear the Space objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Space object by name or id
GET /spaces/{org}/{catalog}/{space}
Get the Space object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Space object by name or id
PATCH /spaces/{org}/{catalog}/{space}
Update the Space object by name or id
Request
Request Body
Space
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Space object by name or id
DELETE /spaces/{org}/{catalog}/{space}
Delete the Space object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Transfer owner to an associate
POST /spaces/{org}/{catalog}/{space}/transfer-owner
Transfer owner to an associate
Request
Request Body
TransferOwner
new_owner_associate_url
string
new_owner_member_url
string
old_owner_new_role_urls
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
owner_url
string
product_urls
array
api_urls
array
task_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Stage a draft product
POST /spaces/{org}/{catalog}/{space}/stage-draft-product
Stage a draft product
Request
Request Body
DraftProductPublish
gateway_service_urls
array
draft_product_url
Required *
string
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Publish a draft product
POST /spaces/{org}/{catalog}/{space}/publish-draft-product
Publish a draft product
Request
Request Body
DraftProductPublish
gateway_service_urls
array
draft_product_url
Required *
string
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Stage the product
POST /spaces/{org}/{catalog}/{space}/stage
Stage the product
Request
Request Body
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Publish the product
POST /spaces/{org}/{catalog}/{space}/publish
Publish the product
Request
Request Body
Path Parameters
Query Parameters
gateway_services
string
The list of gateway service names to support partial publishing
Response
201 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Space Invitation object
POST /catalogs/{org}/{catalog}/space-invitations
Create a Space Invitation object
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Space Invitation objects
GET /catalogs/{org}/{catalog}/space-invitations
List the Space Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Space Invitation objects
DELETE /catalogs/{org}/{catalog}/space-invitations
Clear the Space Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Space Invitation object by name or id
GET /catalogs/{org}/{catalog}/space-invitations/{invitation}
Get the Space Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Space Invitation object by name or id
PATCH /catalogs/{org}/{catalog}/space-invitations/{invitation}
Update the Space Invitation object by name or id
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Space Invitation object by name or id
DELETE /catalogs/{org}/{catalog}/space-invitations/{invitation}
Delete the Space Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Space Invitation
POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/regenerate
Regenerate the Space Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Register using the Space Invitation
POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/register
Register using the Space Invitation
Request
Request Body
InvitationRegister
client_id
string
client_secret
string
user
object
realm
string
username
string
password
string
string
first_name
string
last_name
string
org
object
name
string
title
string
summary
string
catalog
object
name
string
title
string
summary
string
space
object
name
string
title
string
summary
string
consumer_org
object
name
string
title
string
summary
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Accept using the Space Invitation
POST /catalogs/{org}/{catalog}/space-invitations/{invitation}/accept
Accept using the Space Invitation
Request
Request Body
InvitationAccept
client_id
string
client_secret
string
user
object
realm
string
username
string
password
string
token
string
token_secret
string
org
object
name
string
title
string
summary
string
catalog
object
name
string
title
string
summary
string
space
object
name
string
title
string
summary
string
consumer_org
object
name
string
title
string
summary
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
List the Role objects
GET /spaces/{org}/{catalog}/{space}/roles
List the Role objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Role object by name or id
GET /spaces/{org}/{catalog}/{space}/roles/{role}
Get the Role object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role object by name or id
PATCH /spaces/{org}/{catalog}/{space}/roles/{role}
Update the Role object by name or id
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member Invitation object
POST /spaces/{org}/{catalog}/{space}/member-invitations
Create a Member Invitation object
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member Invitation objects
GET /spaces/{org}/{catalog}/{space}/member-invitations
List the Member Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member Invitation objects
DELETE /spaces/{org}/{catalog}/{space}/member-invitations
Clear the Member Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member Invitation object by name or id
GET /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}
Get the Member Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member Invitation object by name or id
PATCH /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}
Update the Member Invitation object by name or id
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member Invitation object by name or id
DELETE /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Member Invitation
POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/regenerate
Regenerate the Member Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Register using the Member Invitation
POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/register
Register using the Member Invitation
Request
Request Body
MemberInvitationRegister
client_id
string
client_secret
string
realm
string
username
string
password
string
string
first_name
string
last_name
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Accept using the Member Invitation
POST /spaces/{org}/{catalog}/{space}/member-invitations/{member-invitation}/accept
Accept using the Member Invitation
Request
Request Body
MemberInvitationAccept
client_id
string
client_secret
string
realm
string
username
string
password
string
token
string
token_secret
string
Path Parameters
Query Parameters
Response
201 - Success
member
Member
credentials
TokenResponse
default -
Create a Member object
POST /spaces/{org}/{catalog}/{space}/members
Create a Member object
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member objects
GET /spaces/{org}/{catalog}/{space}/members
List the Member objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member objects
DELETE /spaces/{org}/{catalog}/{space}/members
Clear the Member objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member object by name or id
GET /spaces/{org}/{catalog}/{space}/members/{member}
Get the Member object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member object by name or id
PATCH /spaces/{org}/{catalog}/{space}/members/{member}
Update the Member object by name or id
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member object by name or id
DELETE /spaces/{org}/{catalog}/{space}/members/{member}
Delete the Member object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Task objects
GET /spaces/{org}/{catalog}/{space}/tasks
List the Task objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Task object by name or id
GET /spaces/{org}/{catalog}/{space}/tasks/{task}
Get the Task object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Task object by name or id
PATCH /spaces/{org}/{catalog}/{space}/tasks/{task}
Update the Task object by name or id
Request
Request Body
Task
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
task_type
string
state
string
actions
array
originator
string
originator_url
string
originator_username
string
comments
array
properties
object
activity
array
org_url
string
catalog_url
string
space_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Application objects
GET /catalogs/{org}/{catalog}/apps
List the Application objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Application objects
GET /spaces/{org}/{catalog}/{space}/apps
List the Application objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Consumer Organization Setting object
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/settings
Get the Consumer Organization Setting object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization Setting object
PUT /consumer-orgs/{org}/{catalog}/{consumer-org}/settings
Update the Consumer Organization Setting object
Request
Request Body
ConsumerOrgSetting
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization Setting object
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/settings
Delete the Consumer Organization Setting object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Consumer Organization Setting object
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings
Get the Consumer Organization Setting object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization Setting object
PUT /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings
Update the Consumer Organization Setting object
Request
Request Body
ConsumerOrgSetting
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization Setting object
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/settings
Delete the Consumer Organization Setting object
Request
Response
200 - Successful delete
type
string
api_version
string
name
string
title
string
summary
string
invitation_ttl
integer
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Activation objects
GET /catalogs/{org}/{catalog}/activations
List the Activation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Activation objects
DELETE /catalogs/{org}/{catalog}/activations
Clear the Activation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Activation object by name or id
GET /activations/{org}/{catalog}/{activation}
Get the Activation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
activation_link
string
string
expires_at
string
user_registry_url
string
identity_provider
string
username
string
first_name
string
last_name
string
consumer_org
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Activation object by name or id
DELETE /activations/{org}/{catalog}/{activation}
Delete the Activation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
activation_link
string
string
expires_at
string
user_registry_url
string
identity_provider
string
username
string
first_name
string
last_name
string
consumer_org
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Consumer Organization Invitation object
POST /catalogs/{org}/{catalog}/consumer-org-invitations
Create a Consumer Organization Invitation object
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Consumer Organization Invitation objects
GET /catalogs/{org}/{catalog}/consumer-org-invitations
List the Consumer Organization Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Consumer Organization Invitation objects
DELETE /catalogs/{org}/{catalog}/consumer-org-invitations
Clear the Consumer Organization Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Consumer Organization Invitation object by name or id
GET /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}
Get the Consumer Organization Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization Invitation object by name or id
PATCH /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}
Update the Consumer Organization Invitation object by name or id
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization Invitation object by name or id
DELETE /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}
Delete the Consumer Organization Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Consumer Organization Invitation
POST /catalogs/{org}/{catalog}/consumer-org-invitations/{invitation}/regenerate
Regenerate the Consumer Organization Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Consumer Organization Invitation object
POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations
Create a Consumer Organization Invitation object
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Consumer Organization Invitation objects
GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations
List the Consumer Organization Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Consumer Organization Invitation objects
DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations
Clear the Consumer Organization Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Consumer Organization Invitation object by name or id
GET /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}
Get the Consumer Organization Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization Invitation object by name or id
PATCH /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}
Update the Consumer Organization Invitation object by name or id
Request
Request Body
Invitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization Invitation object by name or id
DELETE /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}
Delete the Consumer Organization Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Consumer Organization Invitation
POST /spaces/{org}/{catalog}/{space}/consumer-org-invitations/{invitation}/regenerate
Regenerate the Consumer Organization Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
expires_at
string
org_url
string
catalog_url
string
space_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Consumer Organization object
POST /catalogs/{org}/{catalog}/consumer-orgs
Create a Consumer Organization object
Request
Request Body
ConsumerOrg
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Consumer Organization objects
GET /catalogs/{org}/{catalog}/consumer-orgs
List the Consumer Organization objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Consumer Organization objects
DELETE /catalogs/{org}/{catalog}/consumer-orgs
Clear the Consumer Organization objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Consumer Organization object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}
Get the Consumer Organization object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}
Update the Consumer Organization object by name or id
Request
Request Body
ConsumerOrg
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}
Delete the Consumer Organization object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Transfer owner to an associate
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/transfer-owner
Transfer owner to an associate
Request
Request Body
TransferOwner
new_owner_associate_url
string
new_owner_member_url
string
old_owner_new_role_urls
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Consumer Organization object
POST /spaces/{org}/{catalog}/{space}/consumer-orgs
Create a Consumer Organization object
Request
Request Body
ConsumerOrg
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Consumer Organization objects
GET /spaces/{org}/{catalog}/{space}/consumer-orgs
List the Consumer Organization objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Consumer Organization objects
DELETE /spaces/{org}/{catalog}/{space}/consumer-orgs
Clear the Consumer Organization objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Consumer Organization object by name or id
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}
Get the Consumer Organization object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Consumer Organization object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}
Update the Consumer Organization object by name or id
Request
Request Body
ConsumerOrg
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Consumer Organization object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}
Delete the Consumer Organization object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Transfer owner to an associate
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/transfer-owner
Transfer owner to an associate
Request
Request Body
TransferOwner
new_owner_associate_url
string
new_owner_member_url
string
old_owner_new_role_urls
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
owner_url
string
org_url
string
catalog_url
string
group_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Group object
POST /catalogs/{org}/{catalog}/consumer-groups
Create a Group object
Request
Request Body
Group
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Group objects
GET /catalogs/{org}/{catalog}/consumer-groups
List the Group objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Group objects
DELETE /catalogs/{org}/{catalog}/consumer-groups
Clear the Group objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Group object by name or id
GET /catalogs/{org}/{catalog}/consumer-groups/{group}
Get the Group object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Group object by name or id
PATCH /catalogs/{org}/{catalog}/consumer-groups/{group}
Update the Group object by name or id
Request
Request Body
Group
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Group object by name or id
DELETE /catalogs/{org}/{catalog}/consumer-groups/{group}
Delete the Group object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
org_urls
array
gateway_service_urls
array
portal_service_urls
array
user_registry_urls
array
tls_client_profile_urls
array
oauth_provider_urls
array
billing_urls
array
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Payment Method object
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods
Create a Payment Method object
Request
Request Body
PaymentMethod
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
billing_url
string
configuration
object
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
billing_url
string
configuration
object
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Payment Method objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods
List the Payment Method objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Payment Method object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}
Get the Payment Method object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
billing_url
string
configuration
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Payment Method object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/payment-methods/{payment-method}
Update the Payment Method object by name or id
Request
Request Body
PaymentMethod
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
billing_url
string
configuration
object
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
integration_url
string
billing_url
string
configuration
object
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Role object
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/roles
Create a Role object
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles
List the Role objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Role objects
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles
Clear the Role objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Role object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}
Get the Role object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}
Update the Role object by name or id
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Role object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/roles/{role}
Delete the Role object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Role object
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles
Create a Role object
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Role objects
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles
List the Role objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Role objects
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles
Clear the Role objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Role object by name or id
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}
Get the Role object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Role object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}
Update the Role object by name or id
Request
Request Body
Role
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Role object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/roles/{role}
Delete the Role object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
permission_urls
array
inherited_permission_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Associate objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates
List the Associate objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Associate object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/associates/{associate}
Get the Associate object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Associate objects
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates
List the Associate objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Associate object by name or id
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/associates/{associate}
Get the Associate object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member Invitation object
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations
Create a Member Invitation object
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member Invitation objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations
List the Member Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member Invitation objects
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations
Clear the Member Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member Invitation object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}
Get the Member Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member Invitation object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}
Update the Member Invitation object by name or id
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member Invitation object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Member Invitation
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/member-invitations/{member-invitation}/regenerate
Regenerate the Member Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member Invitation object
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations
Create a Member Invitation object
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member Invitation objects
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations
List the Member Invitation objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member Invitation objects
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations
Clear the Member Invitation objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member Invitation object by name or id
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}
Get the Member Invitation object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member Invitation object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}
Update the Member Invitation object by name or id
Request
Request Body
MemberInvitation
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member Invitation object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}
Delete the Member Invitation object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Regenerate the Member Invitation
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/member-invitations/{member-invitation}/regenerate
Regenerate the Member Invitation
Request
Request Body
Regenerate
notify
boolean
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
notify
boolean
activation_link
string
string
org_type
string
role_urls
array
expires_at
string
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member object
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/members
Create a Member object
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members
List the Member objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member objects
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members
Clear the Member objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member object by name or id
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}
Get the Member object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}
Update the Member object by name or id
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/members/{member}
Delete the Member object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Member object
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members
Create a Member object
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Member objects
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members
List the Member objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Member objects
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members
Clear the Member objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Member object by name or id
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}
Get the Member object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Member object by name or id
PATCH /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}
Update the Member object by name or id
Request
Request Body
Member
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
identity_provider
string
username
string
password
string
force_password_change
boolean
string
first_name
string
last_name
string
photo
string
last_login_at
string
member_urls
array
org_url
string
user_registry_url
string
hashed_password
string
salt
string
metadata
object
created_at
string
updated_at
string
url
string
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Member object by name or id
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/members/{member}
Delete the Member object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
user
User
role_urls
array
inherited_role_urls
array
org_url
string
catalog_url
string
space_url
string
consumer_org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Application object
POST /consumer-orgs/{org}/{catalog}/{consumer-org}/apps
Create a Application object
Request
Request Body
App
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Application objects
GET /consumer-orgs/{org}/{catalog}/{consumer-org}/apps
List the Application objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Application objects
DELETE /consumer-orgs/{org}/{catalog}/{consumer-org}/apps
Clear the Application objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Application object by name or id
GET /apps/{org}/{catalog}/{consumer-org}/{app}
Get the Application object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Application object by name or id
PATCH /apps/{org}/{catalog}/{consumer-org}/{app}
Update the Application object by name or id
Request
Request Body
App
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Application object by name or id
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}
Delete the Application object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Application object
POST /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps
Create a Application object
Request
Request Body
App
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Application objects
GET /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps
List the Application objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Application objects
DELETE /consumer-orgs/{org}/{catalog}/{space}/{consumer-org}/apps
Clear the Application objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Application object by name or id
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}
Get the Application object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Application object by name or id
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}
Update the Application object by name or id
Request
Request Body
App
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Application object by name or id
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}
Delete the Application object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
lifecycle_state
string
lifecycle_state_pending
string
app_credential_urls
array
client_id
string
client_secret
string
redirect_endpoints
array
application_public_certificate_entry
string
org_url
string
catalog_url
string
consumer_org_url
string
task_urls
array
image_endpoint
string
application_type_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Application Credential object
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials
Create a Application Credential object
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Application Credential objects
GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials
List the Application Credential objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Application Credential objects
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials
Clear the Application Credential objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Application Credential object by name or id
GET /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}
Get the Application Credential object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Application Credential object by name or id
PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}
Update the Application Credential object by name or id
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Application Credential object by name or id
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}
Delete the Application Credential object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Reset the client id and client secret
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset
Reset the client id and client secret
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Reset the client secret
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret
Reset the client secret
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Verify the client secret
POST /apps/{org}/{catalog}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret
Verify the client secret
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Application Credential object
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials
Create a Application Credential object
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Application Credential objects
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials
List the Application Credential objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Application Credential objects
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials
Clear the Application Credential objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Application Credential object by name or id
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}
Get the Application Credential object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Application Credential object by name or id
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}
Update the Application Credential object by name or id
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Application Credential object by name or id
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}
Delete the Application Credential object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Reset the client id and client secret
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset
Reset the client id and client secret
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Reset the client secret
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/reset-client-secret
Reset the client secret
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Verify the client secret
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/credentials/{credential}/verify-client-secret
Verify the client secret
Request
Request Body
Credential
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
client_id
string
client_secret_hashed
string
client_secret
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Subscription object
POST /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions
Create a Subscription object
Request
Request Body
Subscription
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Subscription objects
GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions
List the Subscription objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Subscription objects
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions
Clear the Subscription objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Subscription object by name or id
GET /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}
Get the Subscription object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Subscription object by name or id
PATCH /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}
Update the Subscription object by name or id
Request
Request Body
Subscription
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Subscription object by name or id
DELETE /apps/{org}/{catalog}/{consumer-org}/{app}/subscriptions/{subscription}
Delete the Subscription object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Create a Subscription object
POST /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions
Create a Subscription object
Request
Request Body
Subscription
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Subscription objects
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions
List the Subscription objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Subscription objects
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions
Clear the Subscription objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Subscription object by name or id
GET /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}
Get the Subscription object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Subscription object by name or id
PATCH /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}
Update the Subscription object by name or id
Request
Request Body
Subscription
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Subscription object by name or id
DELETE /apps/{org}/{catalog}/{space}/{consumer-org}/{app}/subscriptions/{subscription}
Delete the Subscription object by name or id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
title
string
summary
string
state
string
product_url
string
plan
string
task_urls
array
state_pending
string
org_url
string
catalog_url
string
consumer_org_url
string
app_url
string
billing_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Draft objects
GET /orgs/{org}/drafts
List the Draft objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
draft_apis
array
draft_products
array
default -
Clear the Draft objects
DELETE /orgs/{org}/drafts
Clear the Draft objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Introspect the WSDL
POST /orgs/{org}/drafts/introspect-wsdl
Introspect the WSDL
Request
Request Body
Path Parameters
Query Parameters
wsdl_services
string
A comma delimited list of WSDL services to introspect
Response
200 - Success
total_results
integer
results
array
default -
Create a Draft Product object
POST /orgs/{org}/drafts/draft-products
Create a Draft Product object
Request
Request Body
DraftProduct
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Draft Product objects in all collections
GET /orgs/{org}/drafts/draft-products
List all Draft Product objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Draft Product objects in all collections
DELETE /orgs/{org}/drafts/draft-products
Clear all Draft Product objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Draft Product objects
GET /orgs/{org}/drafts/draft-products/{draft-product-name}
List the Draft Product objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Draft Product objects
DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}
Clear the Draft Product objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Draft Product object by id
GET /orgs/{org}/drafts/draft-products/{draft-product-id}
Get the Draft Product object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Draft Product object by id
PATCH /orgs/{org}/drafts/draft-products/{draft-product-id}
Update the Draft Product object by id
Request
Request Body
DraftProduct
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Draft Product object by id
DELETE /orgs/{org}/drafts/draft-products/{draft-product-id}
Delete the Draft Product object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Draft Product object by name and version
GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}
Get the Draft Product object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Draft Product object by name and version
PATCH /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}
Update the Draft Product object by name and version
Request
Request Body
DraftProduct
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Draft Product
DELETE /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}
Delete a Draft Product
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_product
object
gateway_types
array
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Validate the draft product
POST /orgs/{org}/drafts/draft-products/{draft-product-id}/validate
Validate the draft product
Request
Response
200 - Success
result
string
messages
array
default -
Validate the draft product
POST /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/validate
Validate the draft product
Request
Response
200 - Success
result
string
messages
array
default -
Get the Draft Product document
GET /orgs/{org}/drafts/draft-products/{draft-product-id}/document
Get the Draft Product document
Request
Response
200 - Success
default -
Get the Draft Product document by name and version
GET /orgs/{org}/drafts/draft-products/{draft-product-name}/{draft-product-version}/document
Get the Draft Product document by name and version
Request
Response
200 - Success
default -
Create a Draft API object
POST /orgs/{org}/drafts/draft-apis
Create a Draft API object
Request
Request Body
DraftAPI
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
swagger
string
info
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
content_type
Required *
string
content
Required *
string
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Path Parameters
Query Parameters
api_type
string
The type of api (rest, graphql, wsdl_to_rest, or wsdl)
gateway_type
string
The type of the gateway (datapower-gateway, datapower-api-gateway)
assembly_type
string
The type of the assembly to generate (rest_to_proxy)
wsdl_service
string
Name of WSDL service to create the OpenAPI definition from
disable_ws_security
boolean
Disable generation of WS-Security definitions in api
Response
201 - Successful create
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List all Draft API objects in all collections
GET /orgs/{org}/drafts/draft-apis
List all Draft API objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Draft API objects in all collections
DELETE /orgs/{org}/drafts/draft-apis
Clear all Draft API objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Draft API objects
GET /orgs/{org}/drafts/draft-apis/{draft-api-name}
List the Draft API objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Draft API objects
DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}
Clear the Draft API objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Draft API object by id
GET /orgs/{org}/drafts/draft-apis/{draft-api-id}
Get the Draft API object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Draft API object by id
PATCH /orgs/{org}/drafts/draft-apis/{draft-api-id}
Update the Draft API object by id
Request
Request Body
DraftAPI
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
swagger
string
info
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
content_type
Required *
string
content
Required *
string
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Path Parameters
Query Parameters
api_type
string
The type of api (rest, graphql, wsdl_to_rest, or wsdl)
wsdl_service
string
Name of WSDL service to create the OpenAPI definition from
disable_ws_security
boolean
Disable generation of WS-Security definitions in api
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Draft API object by id
DELETE /orgs/{org}/drafts/draft-apis/{draft-api-id}
Delete the Draft API object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Draft API object by name and version
GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}
Get the Draft API object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Draft API object by name and version
PATCH /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}
Update the Draft API object by name and version
Request
Request Body
DraftAPI
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
swagger
string
info
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
content_type
Required *
string
content
Required *
string
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
Path Parameters
Query Parameters
api_type
string
The type of api (rest, graphql, wsdl_to_rest, or wsdl)
wsdl_service
string
Name of WSDL service to create the OpenAPI definition from
disable_ws_security
boolean
Disable generation of WS-Security definitions in api
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Draft API
DELETE /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}
Delete a Draft API
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
draft_api
object
api_type
string
gateway_type
string
oai_version
string
wsdl
object
org_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Validate the draft api
POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/validate
Validate the draft api
Request
Response
200 - Success
result
string
messages
array
default -
Validate the draft api
POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/validate
Validate the draft api
Request
Response
200 - Success
result
string
messages
array
default -
Add a target service
POST /orgs/{org}/drafts/draft-apis/{draft-api-id}/add-target-service
Add a target service
Request
Request Body
Path Parameters
Query Parameters
wsdl_service
string
Name of WSDL service to create the OpenAPI definition from
disable_ws_security
boolean
Disable generation of WS-Security definitions in api
Response
200 - Success
default -
Add a target service
POST /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/add-target-service
Add a target service
Request
Request Body
Path Parameters
Query Parameters
wsdl_service
string
Name of WSDL service to create the OpenAPI definition from
disable_ws_security
boolean
Disable generation of WS-Security definitions in api
Response
200 - Success
default -
Get the Draft API document
GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/document
Get the Draft API document
Request
Response
200 - Success
default -
Get the Draft API document by name and version
GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/document
Get the Draft API document by name and version
Request
Response
200 - Success
default -
Get the Draft API wsdl document
GET /orgs/{org}/drafts/draft-apis/{draft-api-id}/wsdl
Get the Draft API wsdl document
Request
Response
200 - Success
default -
Get the Draft API wsdl document by name and version
GET /orgs/{org}/drafts/draft-apis/{draft-api-name}/{draft-api-version}/wsdl
Get the Draft API wsdl document by name and version
Request
Response
200 - Success
default -
List all Product objects in all collections
GET /catalogs/{org}/{catalog}/products
List all Product objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Product objects in all collections
DELETE /catalogs/{org}/{catalog}/products
Clear all Product objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Product objects
GET /catalogs/{org}/{catalog}/products/{product-name}
List the Product objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Product objects
DELETE /catalogs/{org}/{catalog}/products/{product-name}
Clear the Product objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Product object by id
GET /catalogs/{org}/{catalog}/products/{product-id}
Get the Product object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Product object by id
PATCH /catalogs/{org}/{catalog}/products/{product-id}
Update the Product object by id
Request
Request Body
Product
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
view
Required *
object
subscribe
Required *
object
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
product_url
string
plans
array
supersedes
array
task_urls
array
specialization
ProductSpecialization
spaces
object
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Product object by id
DELETE /catalogs/{org}/{catalog}/products/{product-id}
Delete the Product object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Product object by name and version
GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}
Get the Product object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Product object by name and version
PATCH /catalogs/{org}/{catalog}/products/{product-name}/{product-version}
Update the Product object by name and version
Request
Request Body
Product
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
view
Required *
object
subscribe
Required *
object
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
product_url
string
plans
array
supersedes
array
task_urls
array
specialization
ProductSpecialization
spaces
object
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Product
DELETE /catalogs/{org}/{catalog}/products/{product-name}/{product-version}
Delete a Product
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Hot replace a product
POST /catalogs/{org}/{catalog}/products/{product-id}/replace
Hot replace a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Supersede a product
POST /catalogs/{org}/{catalog}/products/{product-id}/supersede
Supersede a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Set the migration target of a product
POST /catalogs/{org}/{catalog}/products/{product-id}/set-migration-target
Set the migration target of a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate list of subscriptions between products
POST /catalogs/{org}/{catalog}/products/{product-id}/migrate-subscriptions
Migrate list of subscriptions between products
Request
Request Body
MigrateSubscriptionSubset
subscription_urls
array
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate all subscriptions to their migration targets
POST /catalogs/{org}/{catalog}/products/{product-id}/execute-migration-target
Migrate all subscriptions to their migration targets
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Hot replace the product
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/replace
Hot replace the product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Supersede a product
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/supersede
Supersede a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Set the migration target
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/set-migration-target
Set the migration target
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate list of subscriptions between products
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/migrate-subscriptions
Migrate list of subscriptions between products
Request
Request Body
MigrateSubscriptionSubset
subscription_urls
array
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate all subscriptions to their migration targets
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/execute-migration-target
Migrate all subscriptions to their migration targets
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Product document
GET /catalogs/{org}/{catalog}/products/{product-id}/document
Get the Product document
Request
Response
200 - Success
default -
Get the Product document by name and version
GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/document
Get the Product document by name and version
Request
Response
200 - Success
default -
List all API objects in all collections
GET /catalogs/{org}/{catalog}/apis
List all API objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the API objects
GET /catalogs/{org}/{catalog}/apis/{api-name}
List the API objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the API object by id
GET /catalogs/{org}/{catalog}/apis/{api-id}
Get the API object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the API object by id
PATCH /catalogs/{org}/{catalog}/apis/{api-id}
Update the API object by id
Request
Request Body
API
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
content_type
Required *
string
content
Required *
string
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
swagger
string
info
object
gateway_api
object
swagger
string
info
object
consumer_api
object
swagger
string
info
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
spaces
object
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the API object by name and version
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}
Get the API object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the API object by name and version
PATCH /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}
Update the API object by name and version
Request
Request Body
API
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
content_type
Required *
string
content
Required *
string
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
swagger
string
info
object
gateway_api
object
swagger
string
info
object
consumer_api
object
swagger
string
info
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
spaces
object
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the API document
GET /catalogs/{org}/{catalog}/apis/{api-id}/document
Get the API document
Request
Response
200 - Success
default -
Get the API document by name and version
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/document
Get the API document by name and version
Request
Response
200 - Success
default -
Get the API wsdl document
GET /catalogs/{org}/{catalog}/apis/{api-id}/wsdl
Get the API wsdl document
Request
Response
200 - Success
default -
Get the API wsdl document by name and version
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/wsdl
Get the API wsdl document by name and version
Request
Response
200 - Success
default -
List all Product objects in all collections
GET /spaces/{org}/{catalog}/{space}/products
List all Product objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear all Product objects in all collections
DELETE /spaces/{org}/{catalog}/{space}/products
Clear all Product objects in all collections
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
List the Product objects
GET /spaces/{org}/{catalog}/{space}/products/{product-name}
List the Product objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Clear the Product objects
DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}
Clear the Product objects
Request
Path Parameters
Query Parameters
confirm
Required *
string
Confirmation for critical updates
Response
204 - Success
default -
Get the Product object by id
GET /spaces/{org}/{catalog}/{space}/products/{product-id}
Get the Product object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Product object by id
PATCH /spaces/{org}/{catalog}/{space}/products/{product-id}
Update the Product object by id
Request
Request Body
Product
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
view
Required *
object
subscribe
Required *
object
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
product_url
string
plans
array
supersedes
array
task_urls
array
specialization
ProductSpecialization
spaces
object
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete the Product object by id
DELETE /spaces/{org}/{catalog}/{space}/products/{product-id}
Delete the Product object by id
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Product object by name and version
GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}
Get the Product object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Product object by name and version
PATCH /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}
Update the Product object by name and version
Request
Request Body
Product
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
view
Required *
object
subscribe
Required *
object
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
product_url
string
plans
array
supersedes
array
task_urls
array
specialization
ProductSpecialization
spaces
object
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Delete a Product
DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}
Delete a Product
Request
Response
200 - Successful delete
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Hot replace a product
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/replace
Hot replace a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Supersede a product
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/supersede
Supersede a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Set the migration target of a product
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/set-migration-target
Set the migration target of a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate list of subscriptions between products
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/migrate-subscriptions
Migrate list of subscriptions between products
Request
Request Body
MigrateSubscriptionSubset
subscription_urls
array
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate all subscriptions to their migration targets
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/execute-migration-target
Migrate all subscriptions to their migration targets
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Hot replace the product
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/replace
Hot replace the product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Supersede a product
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/supersede
Supersede a product
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Set the migration target
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/set-migration-target
Set the migration target
Request
Request Body
ProductPlanMapping
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate list of subscriptions between products
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/migrate-subscriptions
Migrate list of subscriptions between products
Request
Request Body
MigrateSubscriptionSubset
subscription_urls
array
product_url
string
plans
array
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Migrate all subscriptions to their migration targets
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/execute-migration-target
Migrate all subscriptions to their migration targets
Request
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
product
object
catalog_product
object
state_pending
string
gateway_types
array
space_urls
array
gateway_service_urls
array
visibility
ProductVisibility
api_urls
array
oauth_provider_urls
array
billing_urls
array
superseded_by
ProductPlanMapping
supersedes
array
task_urls
array
specialization
ProductSpecialization
subscription_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the Product document
GET /spaces/{org}/{catalog}/{space}/products/{product-id}/document
Get the Product document
Request
Response
200 - Success
default -
Get the Product document by name and version
GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/document
Get the Product document by name and version
Request
Response
200 - Success
default -
List all API objects in all collections
GET /spaces/{org}/{catalog}/{space}/apis
List all API objects in all collections
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the API objects
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}
List the API objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the API object by id
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}
Get the API object by id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the API object by id
PATCH /spaces/{org}/{catalog}/{space}/apis/{api-id}
Update the API object by id
Request
Request Body
API
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
content_type
Required *
string
content
Required *
string
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
swagger
string
info
object
gateway_api
object
swagger
string
info
object
consumer_api
object
swagger
string
info
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
spaces
object
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the API object by name and version
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}
Get the API object by name and version
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the API object by name and version
PATCH /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}
Update the API object by name and version
Request
Request Body
API
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
content_type
Required *
string
content
Required *
string
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
swagger
string
info
object
gateway_api
object
swagger
string
info
object
consumer_api
object
swagger
string
info
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
spaces
object
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
version
string
title
string
summary
string
scope
string
state
string
api
object
wsdl
object
api_type
string
gateway_type
string
oai_version
string
catalog_api
object
gateway_api
object
consumer_api
object
space_urls
array
gateway_service_urls
array
user_registry_urls
array
oauth_provider_urls
array
tls_client_profile_urls
array
extension_urls
array
policy_urls
array
specialization
APISpecialization
product_urls
array
org_url
string
catalog_url
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Get the API document
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/document
Get the API document
Request
Response
200 - Success
default -
Get the API document by name and version
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/document
Get the API document by name and version
Request
Response
200 - Success
default -
Get the API wsdl document
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/wsdl
Get the API wsdl document
Request
Response
200 - Success
default -
Get the API wsdl document by name and version
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/wsdl
Get the API wsdl document by name and version
Request
Response
200 - Success
default -
Get the Me object
GET /me
Get the Me object
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
context
string
user's login context admin/manager
Response
200 - Success
type
string
api_version
string
state
string
username
string
identity_provider
string
name
string
string
first_name
string
last_name
string
photo
string
force_password_change
boolean
last_login_at
string
url
string
metadata
object
default -
Update the Me object
PUT /me
Update the Me object
Request
Request Body
Me
type
string
api_version
string
state
string
username
string
identity_provider
string
name
string
string
first_name
string
last_name
string
photo
string
force_password_change
boolean
last_login_at
string
url
string
metadata
object
Response
200 - Success
type
string
api_version
string
state
string
username
string
identity_provider
string
name
string
string
first_name
string
last_name
string
photo
string
force_password_change
boolean
last_login_at
string
url
string
metadata
object
default -
Delete the Me object
DELETE /me
Delete the Me object
Request
Response
200 - Successful delete
type
string
api_version
string
state
string
username
string
identity_provider
string
name
string
string
first_name
string
last_name
string
photo
string
force_password_change
boolean
last_login_at
string
url
string
metadata
object
default -
Change my password
POST /me/change-password
Change my password
Request
Request Body
ChangePassword
current_password
string
password
string
Response
204 - Success
default -
Reset password
POST /me/reset-password
Reset password
Request
Request Body
ResetPassword
password
string
Response
204 - Success
default -
Sign out
POST /me/sign-out
Sign out
Request
Response
204 - Success
default -
List the My Permission objects
GET /permissions
List the My Permission objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the My Task objects
GET /tasks
List the My Task objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Originated Task objects
GET /originated-tasks
List the Originated Task objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
total_results
integer
results
array
default -
List the My Organization objects
GET /orgs
List the My Organization objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the My Catalog objects
GET /catalogs
List the My Catalog objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the My Space objects
GET /spaces
List the My Space objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
List the Webhook objects
GET /catalogs/{org}/{catalog}/webhooks
List the Webhook objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
Response
200 - Success
total_results
integer
results
array
default -
Get the Webhook object by name or id
GET /catalogs/{org}/{catalog}/webhooks/{webhook}
Get the Webhook object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
state_change_reason
string
state_change_history
array
tasks
array
endpoint
string
snapshot_endpoint
string
events
array
filter
array
level
string
authorization
string
secret
string
tls_client_profile_url
string
gateway_service_url
string
portal_service_url
string
state_updated_at
string
metadata
object
created_at
string
updated_at
string
url
string
default -
Update the Webhook object by name or id
PATCH /catalogs/{org}/{catalog}/webhooks/{webhook}
Update the Webhook object by name or id
Request
Request Body
Webhook
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
state_change_reason
string
state_change_history
array
tasks
array
endpoint
string
snapshot_endpoint
string
events
array
filter
array
level
string
authorization
string
secret
string
tls_client_profile_url
string
gateway_service_url
string
portal_service_url
string
state_updated_at
string
metadata
object
created_at
string
updated_at
string
url
string
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
state
string
state_change_reason
string
state_change_history
array
tasks
array
endpoint
string
snapshot_endpoint
string
events
array
filter
array
level
string
authorization
string
secret
string
tls_client_profile_url
string
gateway_service_url
string
portal_service_url
string
state_updated_at
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Primary Event objects
GET /catalogs/{org}/{catalog}/primary-events
List the Primary Event objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
state
string
State for a webhook event in subscriber queue
Response
200 - Success
total_results
integer
results
array
default -
Get the Primary Event object by name or id
GET /catalogs/{org}/{catalog}/primary-events/{primary-event}
Get the Primary Event object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
event
string
filter
string
event_type
string
state
string
gateway_payload
object
consumer_payload
object
generated_at
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Primary Event objects
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events
List the Primary Event objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
state
string
State for a webhook event in subscriber queue
Response
200 - Success
total_results
integer
results
array
default -
Get the Primary Event object by name or id
GET /catalogs/{org}/{catalog}/configured-gateway-services/{configured-gateway-service}/primary-events/{primary-event}
Get the Primary Event object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
event
string
filter
string
event_type
string
state
string
gateway_payload
object
consumer_payload
object
generated_at
string
metadata
object
created_at
string
updated_at
string
url
string
default -
List the Subscriber Event objects
GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events
List the Subscriber Event objects
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
offset
integer
Offset item number from list to begin return
limit
integer
Maximum number of items to return
state
string
State for a webhook event in subscriber queue
Response
200 - Success
total_results
integer
results
array
default -
Get the Subscriber Event object by name or id
GET /catalogs/{org}/{catalog}/webhooks/{webhook}/subscriber-events/{subscriber-event}
Get the Subscriber Event object by name or id
Request
Path Parameters
Query Parameters
fields
string
List of field names to return
Response
200 - Success
type
string
api_version
string
id
string
name
string
title
string
summary
string
scope
string
event
string
filter
string
event_type
string
payload_sent
string
payload
object
generated_at
string
state
string
metadata
object
created_at
string
updated_at
string
url
string