openapi: 3.2.0
info:
x-ibm-name: apim
version: 2.0.0
title: IBM API Connect Platform - Provider Space Settings API
description: This API provides operations for accessing API provider capability.
termsOfService: https://www.ibm.com/legal
contact:
name: IBM
url: https://www.ibm.com
email: help@ibm.com
license:
name: tbd
url: https://tbd.com
servers:
- url: ''
description: APIM base path
tags:
- name: Space Settings
paths:
/spaces/{org}/{catalog}/{space}/configured-gateway-services:
description: The collection of Configured Gateway Service operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Creates a configured gateway service
description: 'Adds the gateway service to the list of configured gateway services for a space.
Required fields:
- gateway_service_url
Fields not allowed:
- space_urls
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url
- availability_zone_url'
operationId: configured_gateway_service_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
examples:
ConfiguredGatewayService:
summary: Example of configured gateway service creation at space scope.
value:
gateway_service_url: https://acme-apim.example.com/api/orgs/org1/gateway-services/acme-gateway-service
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
examples:
ConfiguredGatewayService:
summary: Example of configured gateway service creation at space scope.
value:
gateway_service_url: https://acme-apim.example.com/api/orgs/org1/gateway-services/acme-gateway-service
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: Lists configured gateway services
description: Returns the list of configured gateway services for a space.
operationId: configured_gateway_service_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredGatewayServiceList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredGatewayServiceList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clears configured gateway services
description: Removes all gateway services from the list of configured gateway services for a space.
operationId: configured_gateway_service_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}:
description: Configured Gateway Service object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-gateway-service'
get:
summary: Returns a configured gateway service
description: Returns the given gateway service from the list of configured gateway services for a space.
operationId: configured_gateway_service_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Deletes a configured gateway service
description: Removes the given gateway service from the list of configured gateway services for a space.
operationId: configured_gateway_service_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredGatewayService'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-gateway-services/{configured-gateway-service}/download-logs:
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-gateway-service'
get:
summary: Get the Configured Gateway Service download logs
operationId: configured_gateway_service_downloadLogsSpaceScope
security:
- oauth:
- org:view
responses:
'200':
description: Success
content:
application/octet-stream: {}
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-api-user-registries:
description: The collection of Configured API User Registry operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Creates an API user registry
description: 'Adds a user registry to the list of configured API user registries for a space.
Required fields:
- user_registry_url
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url
- user_registry_url'
operationId: configured_api_user_registry_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
examples:
ConfiguredAPIUserRegistry:
summary: Example of configured api user registry creation at space scope.
value:
user_registry_url: https://api.acme-apim.example.com/api/user-registries/org1/user-registry-1
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
examples:
ConfiguredAPIUserRegistry:
summary: Example of configured api user registry creation at space scope.
value:
user_registry_url: https://api.acme-apim.example.com/api/user-registries/org1/user-registry-1
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: Lists API user registries
description: Returns the list of configured API user registries for a space.
operationId: configured_api_user_registry_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistryList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistryList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clears API user registries from a space
description: Removes all configured API user registries from a space.
operationId: configured_api_user_registry_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-api-user-registries/{configured-api-user-registry}:
description: Configured API User Registry object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-api-user-registry'
get:
summary: Returns an API user registry
description: Returns the given configured API user registry for a space.
operationId: configured_api_user_registry_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Deletes an API user registry
description: Removes a user registry from the list of configured API user registries for a space.
operationId: configured_api_user_registry_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-tls-client-profiles:
description: Configured TLS Client Profile operations across all collections
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Creates a configured TLS client profile
description: 'Adds a TLS client profile to the list of configured TLS client profiles for a space.
Required fields:
- tls_client_profile_url
Fields not allowed:
- space_urls
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url'
operationId: configured_tls_client_profile_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
examples:
ConfiguredTLSClientProfileSpace:
summary: Example configured catalog user registry create at space scope.
value:
tls_client_profile_url: https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
examples:
ConfiguredTLSClientProfileSpace:
summary: Example configured catalog user registry create at space scope.
value:
tls_client_profile_url: https://api.acme-apim.example.com/api/orgs/acme-org/tls-client-profiles/acme-tls-client-profile
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: Lists TLS client profiles
description: Returns the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_listAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfileList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfileList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clears TLS client profiles
description: Removes all TLS client profiles from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_clearAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}:
description: The collection of Configured TLS Client Profile operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-tls-client-profile-name'
get:
summary: Lists TLS client profiles
description: Returns all versions of the named TLS client profile from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfileList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfileList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clears TLS client profiles
description: Removes all versions of the named TLS client profile from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-id}:
description: Configured TLS Client Profile object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-tls-client-profile-id'
get:
summary: Returns a TLS client profile
description: Returns the given TLS client profile from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Deletes a TLS client profile
description: Removes the given TLS client profile from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
? /spaces/{org}/{catalog}/{space}/configured-tls-client-profiles/{configured-tls-client-profile-name}/{configured-tls-client-profile-version}
: description: Configured TLS Client Profile object operations by name and version
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-tls-client-profile-name'
- $ref: '#/components/parameters/configured-tls-client-profile-version'
get:
summary: Returns a TLS client profile
description: Returns the given TLS client profile from the list of configured TLS client profiles for a space.
operationId: configured_tls_client_profile_getByNameVersionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Delete a Configured TLS Client Profile
operationId: configured_tls_client_profile_delByNameVersionSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-jwt-providers:
description: The collection of Configured Jwt Provider operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Create a Configured Jwt Provider object
description: 'Create a Configured Jwt Provider object
Required fields:
- jwt_provider_url
Fields not allowed:
- space_urls
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url'
operationId: configured_jwt_provider_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
examples:
ConfiguredJwtProvider:
summary: Example for Configure JWT provider
value:
jwt_provider_url: https://api.acme-apim.example.com/api/orgs/acme-org/jwt-providers/jwt-provider1
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
examples:
ConfiguredJwtProvider:
summary: Example for Configure JWT provider
value:
jwt_provider_url: https://api.acme-apim.example.com/api/orgs/acme-org/jwt-providers/jwt-provider1
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: List the Configured Jwt Provider objects
operationId: configured_jwt_provider_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredJwtProviderList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredJwtProviderList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clear the Configured Jwt Provider objects
operationId: configured_jwt_provider_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-jwt-providers/{configured-jwt-provider}:
description: Configured Jwt Provider object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-jwt-provider'
get:
summary: Get the Configured Jwt Provider object by name or id
operationId: configured_jwt_provider_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Delete the Configured Jwt Provider object by name or id
operationId: configured_jwt_provider_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredJwtProvider'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-oauth-providers:
description: The collection of Configured Oauth Provider operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Creates a configured OAuth provider
description: 'Adds an OAuth provider to the list of configured OAuth providers for a space.
Required fields:
- oauth_provider_url
Fields not allowed:
- space_urls
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url'
operationId: configured_oauth_provider_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
examples:
ConfiguredOauthProvider:
summary: Example of configured oauth provider creation at space scope.
value:
oauth_provider_url: https://acme-apim.example.com/api/orgs/org1/oauth-providers/acme-oauth-provider
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
examples:
ConfiguredOauthProvider:
summary: Example of configured oauth provider creation at space scope.
value:
oauth_provider_url: https://acme-apim.example.com/api/orgs/org1/oauth-providers/acme-oauth-provider
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: Lists configured OAuth providers
description: Returns the list of configured OAuth providers for a space.
operationId: configured_oauth_provider_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredOauthProviderList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredOauthProviderList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clear the Configured Oauth Provider objects
description: Removes all OAuth providers from the list of configured OAuth providers for a catalog.
operationId: configured_oauth_provider_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-oauth-providers/{configured-oauth-provider}:
description: Configured Oauth Provider object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-oauth-provider'
get:
summary: Returns a configured OAuth provider
description: Returns the given OAuth provider from the list of configured OAuth providers for a space.
operationId: configured_oauth_provider_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Delete the Configured Oauth Provider object by name or id
description: Removes an OAuth provider from the list of configured OAuth providers for a space.
operationId: configured_oauth_provider_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredOauthProvider'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-programming-packages:
description: Configured Programming Package operations across all collections
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
post:
summary: Create a Configured Programming Package object
description: 'Create a Configured Programming Package object
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url'
operationId: configured_programming_package_createSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
responses:
'201':
description: Successful create
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
'302':
description: Redirect response
headers:
Location:
description: Redirect payload
schema:
type: string
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
get:
summary: List all Configured Programming Package objects in all collections
operationId: configured_programming_package_listAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackageList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackageList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clear all Configured Programming Package objects in all collections
operationId: configured_programming_package_clearAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-programming-packages/{configured-programming-package-name}:
description: The collection of Configured Programming Package operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-programming-package-name'
get:
summary: List the Configured Programming Package objects
operationId: configured_programming_package_listSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackageList'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackageList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Clear the Configured Programming Package objects
operationId: configured_programming_package_clearSpaceScope
security:
- oauth:
- org:manage
parameters:
- $ref: '#/components/parameters/confirm'
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/configured-programming-packages/{configured-programming-package-id}:
description: Configured Programming Package object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-programming-package-id'
get:
summary: Get the Configured Programming Package object by id
operationId: configured_programming_package_getSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Delete the Configured Programming Package object by id
operationId: configured_programming_package_delSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
? /spaces/{org}/{catalog}/{space}/configured-programming-packages/{configured-programming-package-name}/{configured-programming-package-version}
: description: Configured Programming Package object operations by name and version
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/configured-programming-package-name'
- $ref: '#/components/parameters/configured-programming-package-version'
get:
summary: Get the Configured Programming Package object by name and version
operationId: configured_programming_package_getByNameVersionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
delete:
summary: Delete a Configured Programming Package
operationId: configured_programming_package_delByNameVersionSpaceScope
security:
- oauth:
- org:manage
responses:
'200':
description: Successful delete
content:
application/json:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
application/yaml:
schema:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings:
description: Space Setting object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Returns space settings
description: Returns the settings for a space.
operationId: space_setting_singletonGet
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SpaceSetting'
application/yaml:
schema:
$ref: '#/components/schemas/SpaceSetting'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
put:
summary: Updates space settings
description: 'Updates the settings for a space.
Fields allowed but ignored:
- name
- type
- api_version
- scope
- created_at
- updated_at
- url
- org_url
- catalog_url
- space_url'
operationId: space_setting_singletonUpdate
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SpaceSetting'
examples:
SpaceSetting:
summary: Example of fields which can be updated on a space settings object.
value:
invitation_ttl: 172800
custom_notification_templates_enabled: true
allowed_product_visibility:
view:
type: public
enabled: false
subscribe:
type: authenticated
enabled: false
email_sender:
name: ACME Mail
custom: true
address: acme-mail@example.com
subscription_task_approval_retention: 60
application/yaml:
schema:
$ref: '#/components/schemas/SpaceSetting'
examples:
SpaceSetting:
summary: Example of fields which can be updated on a space settings object.
value:
invitation_ttl: 172800
custom_notification_templates_enabled: true
allowed_product_visibility:
view:
type: public
enabled: false
subscribe:
type: authenticated
enabled: false
email_sender:
name: ACME Mail
custom: true
address: acme-mail@example.com
subscription_task_approval_retention: 60
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SpaceSetting'
application/yaml:
schema:
$ref: '#/components/schemas/SpaceSetting'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates:
description: Notification Template operations across all collections
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Lists space notification templates
description: Returns the list of all notification templates for a space.
operationId: notification_template_listAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/space:
description: The collection of Notification Template operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Lists space notification templates
description: Returns the list of all space notification templates set at the space organization level.
operationId: notification_template_listSpaceSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}:
description: Notification Template object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
get:
summary: Returns a space notification template
description: Returns a space notification template, set at the space level.
operationId: notification_template_getSpaceSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
patch:
summary: Updates a space notification template
description: 'Updates a space notification template set at the space level.
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url'
operationId: notification_template_updateSpaceSubcollectionSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
examples:
NotificationTemplate:
summary: Example of notification template update at space scope and space subcollection.
value:
title: Acme notification template
subject: Invitation to join Acme
body: 'Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
examples:
NotificationTemplate:
summary: Example of notification template update at space scope and space subcollection.
value:
title: Acme notification template
subject: Invitation to join Acme
body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}/notification-languages:
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
get:
summary: List the Notification language objects
operationId: notification_language_listSpaceSubcollectionSpaceScope
security:
- oauth:
- org:view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguageList'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguageList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
? /spaces/{org}/{catalog}/{space}/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language}
: parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
- $ref: '#/components/parameters/notification-language'
get:
summary: Get the Notification template language by name or id
operationId: notification_language_getSpaceSubcollectionSpaceScope
security:
- oauth:
- org:view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
patch:
summary: Update the Notification template language object
operationId: notification_language_updateSpaceSubcollectionSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
examples:
NotificationLanguage:
summary: Example of notification language update at space scope and space subcollection.
value:
title: Example notification language update
notification_template_name: invitation
notification_template_type: space
subject: Invitation to join Acme
body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
- html
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer:
description: The collection of Notification Template operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Lists consumer notification templates
description: Returns the list of all consumer notification templates set at the space level.
operationId: notification_template_listConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplateList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}:
description: Notification Template object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
get:
summary: Returns a consumer notification template
description: Returns a consumer notification template, set at the space level.
operationId: notification_template_getConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
patch:
summary: Updates a consumer notification template
description: 'Updates a consumer notification template set at the space level.
Fields allowed but ignored:
- id
- type
- api_version
- scope
- created_at
- updated_at
- url'
operationId: notification_template_updateConsumerSubcollectionSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
examples:
NotificationTemplate:
summary: Example of notification template update at space scope and consumer subcollection.
value:
title: Acme notification template
subject: Invitation to join Acme
body: 'Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
examples:
NotificationTemplate:
summary: Example of notification template update at space scope and consumer subcollection.
value:
title: Acme notification template
subject: Invitation to join Acme
body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationTemplate'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationTemplate'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}/notification-languages:
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
get:
summary: List the Notification language objects
operationId: notification_language_listConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguageList'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguageList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
? /spaces/{org}/{catalog}/{space}/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language}
: parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/notification-template'
- $ref: '#/components/parameters/notification-language'
get:
summary: Get the Notification template language by name or id
operationId: notification_language_getConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
patch:
summary: Update the Notification template language object
operationId: notification_language_updateConsumerSubcollectionSpaceScope
security:
- oauth:
- org:manage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
examples:
NotificationLanguage:
summary: Example of notification language update at space scope and consumer subcollection.
value:
title: Example notification language update
notification_template_name: invitation
notification_template_type: consumer
subject: Invitation to join Acme
body: 'Hello, You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
'
body_html: Hello,
You have been invited to join Acme. This invitation provides access to collaborate and manage resources within the platform.
content_type:
- text
- html
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationLanguage'
application/yaml:
schema:
$ref: '#/components/schemas/NotificationLanguage'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/role-defaults:
description: Role Default operations across all collections
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Lists space role defaults
description: Returns the list of all role defaults for a space.
operationId: role_default_listAllSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RoleDefaultList'
application/yaml:
schema:
$ref: '#/components/schemas/RoleDefaultList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/role-defaults/consumer:
description: The collection of Role Default operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
get:
summary: Lists consumer organization role defaults
description: Returns the list of consumer organization role defaults in a space.
operationId: role_default_listConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RoleDefaultList'
application/yaml:
schema:
$ref: '#/components/schemas/RoleDefaultList'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
/spaces/{org}/{catalog}/{space}/role-defaults/consumer/{role-default}:
description: Role Default object operations
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/catalog'
- $ref: '#/components/parameters/space'
- $ref: '#/components/parameters/role-default'
get:
summary: Returns a consumer organization role default
description: Returns a consumer organization role default for a space.
operationId: role_default_getConsumerSubcollectionSpaceScope
security:
- oauth:
- org:view
parameters:
- $ref: '#/components/parameters/fields'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RoleDefault'
application/yaml:
schema:
$ref: '#/components/schemas/RoleDefault'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
tags:
- Space Settings
components:
schemas:
ConfiguredJwtProvider:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_jwt_provider
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
debug:
type: boolean
jwt_provider_url:
type: string
format: uri
owned:
type: boolean
gateway_version:
type: string
enum:
- '12000'
native_jwt_provider:
type: object
additionalProperties: false
properties:
jwks_config:
type: string
enum:
- signing
- encryption
- nested
jws_jwk_source:
type:
- string
- 'null'
enum:
- kube_secret
- endpoint
jwe_jwk_source:
type:
- string
- 'null'
enum:
- kube_secret
- endpoint
signing_key:
type:
- string
- 'null'
encryption_key:
type:
- string
- 'null'
signing_key_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
security:
type: array
items:
type: string
enum:
- basic-auth
- none
basic_auth:
type: object
additionalProperties: false
properties:
username:
type: string
password:
type:
- string
- 'null'
tls_client_profile_url:
type:
- string
- 'null'
format: uri
version:
type:
- string
- 'null'
enum:
- HTTP/1.0
- HTTP/1.1
- HTTP/2
url_type:
type:
- string
- 'null'
enum:
- plain
- variables
- jsonata
timeout:
type:
- integer
- 'null'
persistent_connections:
type: boolean
compress_request:
type:
- string
- 'null'
enum:
- br
- gzip
- deflate
- none
decompress_response:
type: boolean
chunked_upload:
type: boolean
follow_redirects:
type: boolean
encryption_key_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
security:
type: array
items:
type: string
enum:
- basic-auth
- none
basic_auth:
type: object
additionalProperties: false
properties:
username:
type: string
password:
type:
- string
- 'null'
tls_client_profile_url:
type:
- string
- 'null'
format: uri
version:
type:
- string
- 'null'
enum:
- HTTP/1.0
- HTTP/1.1
- HTTP/2
url_type:
type:
- string
- 'null'
enum:
- plain
- variables
- jsonata
timeout:
type:
- integer
- 'null'
persistent_connections:
type: boolean
compress_request:
type:
- string
- 'null'
enum:
- br
- gzip
- deflate
- none
decompress_response:
type: boolean
chunked_upload:
type: boolean
follow_redirects:
type: boolean
clock_skew:
type:
- integer
- 'null'
aud_claim:
type:
- array
- 'null'
items:
type: string
iss_claim:
type:
- string
- 'null'
tls_client_profile_urls:
type: array
items:
type: string
format: uri
configured_gateway_service_urls:
type: array
items:
type: string
format: uri
api_urls:
type: array
items:
type: string
format: uri
product_urls:
type: array
items:
type: string
format: uri
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ConfiguredProgrammingPackage:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_programming_package
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
version:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
programming_package_url:
type: string
format: uri
programming_package:
type: array
items:
type: object
additionalProperties: false
required:
- file_content
- file_name
- mimetype
properties:
file_content:
type: string
format: binary
file_name:
type: string
mimetype:
type: string
subpath:
type: string
programming_package_type:
type: string
enum:
- lua
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
SubscriberProcessingStatus:
type: object
additionalProperties: false
properties:
service_state:
type: string
enum:
- green
- orange
- red
service_up_to_date:
type: boolean
last_processed_event:
type: object
properties:
event_id:
type: string
title:
type: string
filter:
type: string
generated_at:
type: string
processed_at:
type: string
event_processing_time:
type: integer
elapsed_time_since_last_processed_event:
type: integer
first_failed_event:
$ref: '#/components/schemas/SubscriberEventStatus'
number_of_outstanding_sent_events:
type: integer
minimum: 0
maximum: 2147483647
last_sent_event:
type: object
properties:
event_id:
type: string
title:
type: string
sent_at:
type: string
generated_at:
type: string
number_of_outstanding_queued_events:
type: integer
minimum: 0
maximum: 2147483647
NotificationTemplateList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/NotificationTemplate'
ConfiguredProgrammingPackageList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredProgrammingPackage'
ConfiguredTLSClientProfileList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredTLSClientProfile'
RoleDefaultList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/RoleDefault'
RoleDefault:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- role_default
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
role_default_type:
type: string
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
permission_urls:
type: array
items:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ConfiguredGatewayServiceList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredGatewayService'
Error:
type: object
additionalProperties: false
properties:
status:
type: integer
minimum: 400
maximum: 599
message:
type: array
items:
type: string
errors:
type: array
items:
type: string
NotificationLanguage:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- notification_language
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
variables:
type: array
items:
type: string
subject:
type: string
body:
type: string
body_html:
type: string
content_type:
type: array
items:
type: string
enum:
- text
- html
notification_template_name:
type: string
notification_template_type:
type: string
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
consumer_org_url:
type: string
format: uri
notification_template_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ConfiguredOauthProviderList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredOauthProvider'
SubscriberEvent:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- subscriber_event
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
event:
type: string
filter:
type: string
event_type:
type: string
enum:
- create
- update
- delete
payload_sent:
type: string
payload:
type: object
generated_at:
type: string
state:
type: string
enum:
- queued
- sent
- failed
retries:
type: integer
minimum: 0
maximum: 2147483647
request_id:
type: string
ids_in_payload:
type: array
readOnly: true
items:
type: object
additionalProperties: false
properties:
resourceUrl:
type: string
format: uri-reference
resourceType:
type: string
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ConfiguredGatewayService:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_gateway_service
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
gateway_service_url:
type: string
format: uri
integration_url:
type: string
format: uri
gateway_service_type:
type: string
owned:
type: boolean
configuration:
type: object
availability_zone_url:
type: string
format: uri
endpoint:
type: string
format: uri
api_endpoint_base:
type: string
catalog_base:
type: string
sni:
type: array
items:
type: object
additionalProperties: false
properties:
host:
type: string
tls_server_profile_url:
type: string
format: uri
oauth_shared_secret:
type: string
format: password
state:
type: string
enum:
- pending
- ready
overall_state:
type: string
enum:
- pending
- ready
tls_client_profile_url:
type: string
format: uri
analytics_service_url:
type:
- string
- 'null'
format: uri
gateway_version:
type: string
domain_name:
type: string
managed_by:
type: string
enum:
- apim
- gateway
product_urls:
type: array
items:
type: string
format: uri
configured_oauth_provider_urls:
type: array
items:
type: string
format: uri
configured_jwt_provider_urls:
type: array
items:
type: string
format: uri
api_urls:
type: array
items:
type: string
format: uri
catalog_setting_urls:
type: array
items:
type: string
format: uri
webhook_url:
type: string
format: uri
catalog_webhook_url:
type: string
format: uri
webhook_state:
type: string
catalog_webhook_state:
type: string
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
gateway_processing_status:
$ref: '#/components/schemas/SubscriberProcessingStatus'
events:
type: object
properties:
sent_events:
type: array
items:
$ref: '#/components/schemas/SubscriberEvent'
queued_events:
type: array
items:
$ref: '#/components/schemas/SubscriberEvent'
failed_events:
type: array
items:
$ref: '#/components/schemas/SubscriberEventStatus'
tls_server_profile_ca:
type: string
service_version:
type:
- string
- 'null'
communication_kind:
type: string
enum:
- external
- internal_svc
communication_to_analytics_kind:
type: string
enum:
- external
- internal_svc
communication_to_analytics_with_jwt:
type:
- boolean
- 'null'
ldap_cxn_pool:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
idle_timeout:
type: integer
minimum: 1
maximum: 86400
max_pool_size:
type: integer
minimum: 1
maximum: 2000
document_cache_size:
type: integer
minimum: 0
maximum: 2147483647
service_supported_features:
type: array
items:
type: string
ai_gateway_enabled:
type: boolean
cipher_suites:
type: array
items:
type: string
disabled_protocols:
type: array
items:
type: string
opentelemetry_url:
type:
- string
- 'null'
format: uri
dp_nano_gw_limits:
type: object
additionalProperties: false
properties:
cpu:
type: string
memory:
type: string
replicas:
type: integer
minimum: 0
maximum: 128
allow_overrides:
type: boolean
hpa:
type: object
additionalProperties: false
properties:
min_replicas:
type: integer
minimum: 1
maximum: 100
max_replicas:
type: integer
minimum: 1
maximum: 100
dp_nano_gw_configuration:
type: object
additionalProperties: false
properties:
hpa:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
min_replicas:
type: integer
minimum: 1
max_replicas:
type: integer
minimum: 2
target_cpu:
type: integer
minimum: 1
target_memory:
type: integer
minimum: 1
to_zero_time:
type: integer
minimum: 0
from_zero_replicas:
type: integer
minimum: 1
maximum: 100
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
SpaceSetting:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- space_setting
api_version:
type: string
readOnly: true
enum:
- 2.0.0
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
invitation_ttl:
type: integer
minimum: 0
maximum: 2147483647
custom_notification_templates_enabled:
type: boolean
allowed_product_visibility:
$ref: '#/components/schemas/ProductVisibility'
email_sender:
$ref: '#/components/schemas/EmailSender'
subscription_task_approval_retention:
type: integer
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
postman_setting:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
NotificationLanguageList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/NotificationLanguage'
NotificationTemplate:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- notification_template
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
notification_template_type:
type: string
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
variables:
type: array
items:
type: string
subject:
type: string
body:
type: string
body_html:
type: string
content_type:
type: array
items:
type: string
enum:
- text
- html
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
consumer_org_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ProductVisibility:
type: object
additionalProperties: false
required:
- view
- subscribe
properties:
view:
type: object
additionalProperties: false
required:
- type
properties:
type:
type: string
enum:
- public
- authenticated
- custom
enabled:
type: boolean
group_urls:
type:
- array
- 'null'
items:
type: string
format: uri
org_urls:
type:
- array
- 'null'
items:
type: string
format: uri
subscribe:
type: object
additionalProperties: false
required:
- type
properties:
type:
type: string
enum:
- authenticated
- custom
enabled:
type: boolean
group_urls:
type:
- array
- 'null'
items:
type: string
format: uri
org_urls:
type:
- array
- 'null'
items:
type: string
format: uri
EmailSender:
type: object
additionalProperties: false
properties:
custom:
type: boolean
name:
type: string
address:
type: string
PublicKeyJwk:
type:
- object
- 'null'
additionalProperties: false
properties:
kty:
type: string
n:
type: string
e:
type: string
alg:
type: string
kid:
type: string
use:
type: string
ConfiguredJwtProviderList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredJwtProvider'
ConfiguredOauthProvider:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_oauth_provider
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
oauth_provider_url:
type: string
format: uri
owned:
type: boolean
debug:
type: boolean
provider_type:
type: string
enum:
- native
- third_party
scopes:
type:
- object
- 'null'
additionalProperties:
type: string
grants:
type: array
items:
type: string
enum:
- access_code
- application
- password
- implicit
- jwt
gateway_version:
type: string
enum:
- '5000'
- '6000'
- '12000'
- '13000'
advanced_scope:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
override_endpoint_from_api:
type: boolean
default_validator_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
tls_client_profile_url:
type:
- string
- 'null'
format: uri
request_query:
type: string
request_headers_regex:
type: string
response_headers_regex:
type: string
advanced_scope_12000:
type: object
additionalProperties: false
properties:
default_validator_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
tls_client_profile_url:
type:
- string
- 'null'
format: uri
version:
type:
- string
- 'null'
enum:
- HTTP/1.0
- HTTP/1.1
- HTTP/2
timeout:
type:
- integer
- 'null'
persistent_connections:
type: boolean
compress_request:
type:
- string
- 'null'
enum:
- br
- gzip
- deflate
- none
decompress_response:
type: boolean
chunked_upload:
type: boolean
follow_redirects:
type: boolean
native_provider:
type: object
additionalProperties: false
properties:
api:
$ref: '#/components/schemas/OAI3'
default_scopes:
type:
- string
- 'null'
authorize_path:
type: string
token_path:
type: string
token_secret:
type:
- object
- 'null'
additionalProperties: false
properties:
name:
type: string
key:
type: string
clients:
type: array
items:
type: string
enum:
- confidential
- public
access_code_ttl:
type: integer
minimum: 1
maximum: 600
access_token_ttl:
type: integer
minimum: 0
maximum: 2147483647
access_token_one_time_use:
type: boolean
maximum_consent_ttl:
type: integer
minimum: 0
maximum: 2147483647
refresh_token:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
count:
type: integer
minimum: 0
maximum: 2147483647
ttl:
type: integer
minimum: 0
maximum: 2147483647
one_time_use:
type: boolean
revocation:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
type:
type: string
enum:
- native
- third_party
resource_owner_revocation_path:
type: string
client_revocation_path:
type: string
third_party_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
tls_client_profile_url:
type:
- string
- 'null'
format: uri
application_revocation:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
apprevoke_path:
type: string
third_party_security:
type: array
items:
type: string
enum:
- basic-auth
basic_auth:
type: object
additionalProperties: false
properties:
username:
type: string
password:
type:
- string
- 'null'
request_headername:
type: string
custom_headername_format:
type: string
third_party_cache_type:
type: array
items:
type: string
enum:
- no-cache
- protocol
- time-to-live
third_party_revocation_protocol:
type: string
items:
type: string
enum:
- XML
- JSON
time_to_live:
type: object
additionalProperties: false
properties:
cache_ttl:
type: integer
third_party_fail_on_error:
type: boolean
default: true
owner_revocation:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
owner_revoke_path:
type: string
token_introspection:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
introspection_path:
type: string
token_metadata:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
source:
type: array
items:
type: string
enum:
- external_url
- authentication_url
external_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
tls_client_profile_url:
type:
- string
- 'null'
format: uri
header_name_token:
type: string
header_name_payload:
type: string
openid_connect:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
discovery_path:
type:
- string
- 'null'
supported_response_types:
type: array
items:
type: string
enum:
- code_id_token
- code_access_token
- code_id_token_access_token
pkce:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
required:
type: boolean
allow_plain:
type: boolean
advanced_scope_security:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
mode:
type: array
items:
type: string
enum:
- basic-auth
basic_auth:
type: object
additionalProperties: false
properties:
request_headername:
type: string
username:
type: string
password:
type:
- string
- 'null'
native_provider_5000:
type: object
additionalProperties: false
properties:
identity_extraction:
type: object
additionalProperties: false
properties:
type:
type: string
enum:
- basic
- default_form
- custom_form
- redirect
redirect_endpoint:
type:
- string
- 'null'
custom_form_endpoint:
$ref: '#/components/schemas/SecuredEndpoint'
authentication:
type: object
additionalProperties: false
properties:
user_registry_url:
type: string
format: uri
authorization:
type: object
additionalProperties: false
properties:
type:
type: string
enum:
- default_form
- custom_form
- authenticated
custom_form_endpoint:
$ref: '#/components/schemas/SecuredEndpoint'
scope_validators:
type: object
additionalProperties: false
properties:
application_endpoint:
$ref: '#/components/schemas/SecuredEndpoint'
owner_endpoint:
$ref: '#/components/schemas/SecuredEndpoint'
third_party_config:
type: object
additionalProperties: false
properties:
token_validation_requirement:
type: string
enum:
- connected
- active
- custom
authorize_endpoint:
type: string
token_endpoint:
type: string
introspection_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
tls_client_profile_url:
type:
- string
- 'null'
format: uri
security:
type: array
items:
type: string
enum:
- basic-auth
basic_auth:
type: object
additionalProperties: false
properties:
request_headername:
type:
- string
- 'null'
username:
type: string
password:
type:
- string
- 'null'
custom_headername_format:
type: string
advanced_scope_security:
type: object
additionalProperties: false
properties:
enabled:
type: boolean
mode:
type: array
items:
type: string
enum:
- basic-auth
basic_auth:
type: object
additionalProperties: false
properties:
request_headername:
type: string
username:
type: string
password:
type:
- string
- 'null'
auth_header_pass_thru:
type: boolean
default: false
introspect_cache_type:
type: string
default: no-cache
enum:
- no-cache
- protocol
- time-to-live
introspect_cache_ttl:
type: integer
third_party_config_12000:
type: object
additionalProperties: false
properties:
oauth_specification:
type: string
enum:
- oauth2.0
- oauth2.1
jwt_provider_url:
type: string
format: uri
introspection_endpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
security:
type: array
items:
type: string
enum:
- basic-auth
basic_auth:
type: object
additionalProperties: false
properties:
body_credentials:
type:
- object
- 'null'
additionalProperties: false
properties:
id:
type: string
secret:
type:
- string
- 'null'
username:
type: string
password:
type:
- string
- 'null'
tls_client_profile_url:
type:
- string
- 'null'
format: uri
version:
type:
- string
- 'null'
enum:
- HTTP/1.0
- HTTP/1.1
- HTTP/2
timeout:
type:
- integer
- 'null'
persistent_connections:
type: boolean
compress_request:
type:
- string
- 'null'
enum:
- br
- gzip
- deflate
- none
decompress_response:
type: boolean
chunked_upload:
type: boolean
follow_redirects:
type: boolean
third_party_config_13000:
type: object
additionalProperties: false
properties:
introspection_mode:
type: string
enum:
- remote
- local
remote_introspection:
type: object
additionalProperties: false
properties:
gateway_user:
type: string
local_introspection:
type: object
additionalProperties: false
properties:
issuer:
type: string
jwks_uri:
type: string
use_local_clock_skew:
type: boolean
clock_skew_in_seconds:
type: integer
token_generator:
type: object
additionalProperties: false
properties:
access_token_exp_interval:
type: integer
auth_code_exp_interval:
type: integer
expiry:
type: integer
enforce_pkce:
type: boolean
algorithm:
type: string
refresh_token_url:
type: string
dcr:
type: object
additionalProperties: false
properties:
provider_name:
type: string
endpoint:
type: string
endpoint_headers:
type: object
additionalProperties:
type: string
auth_type:
type: string
enum:
- basic
- token
- refresh_token
- client_credentials
- none
username:
type:
- string
- 'null'
password:
type:
- string
- 'null'
token:
type:
- string
- 'null'
token_type:
type:
- string
- 'null'
client_id:
type:
- string
- 'null'
client_secret:
type:
- string
- 'null'
scope:
type:
- string
- 'null'
user_registry_urls:
type: array
items:
type: string
format: uri
jwt_provider_urls:
type: array
items:
type: string
format: uri
tls_client_profile_urls:
type: array
items:
type: string
format: uri
configured_gateway_service_urls:
type: array
items:
type: string
format: uri
api_urls:
type: array
items:
type: string
format: uri
product_urls:
type: array
items:
type: string
format: uri
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
ConfiguredAPIUserRegistryList:
type: object
additionalProperties: false
properties:
total_results:
type: integer
results:
type: array
items:
$ref: '#/components/schemas/ConfiguredAPIUserRegistry'
OAI3:
type:
- object
- 'null'
additionalProperties: true
ConfiguredTLSClientProfile:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_tls_client_profile
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
version:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
tls_client_profile_url:
type: string
format: uri
owned:
type: boolean
protocols:
type: array
items:
type: string
enum:
- tls_v1.0
- tls_v1.1
- tls_v1.2
- tls_v1.3
ciphers:
type:
- array
- 'null'
items:
type: string
enum:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
- TLS_AES_128_CCM_SHA256
- TLS_AES_128_CCM_8_SHA256
- ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- ECDHE_RSA_WITH_AES_256_GCM_SHA384
- ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- ECDHE_RSA_WITH_AES_256_CBC_SHA384
- ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- ECDHE_RSA_WITH_AES_256_CBC_SHA
- DHE_DSS_WITH_AES_256_GCM_SHA384
- DHE_RSA_WITH_AES_256_GCM_SHA384
- DHE_RSA_WITH_AES_256_CBC_SHA256
- DHE_DSS_WITH_AES_256_CBC_SHA256
- DHE_RSA_WITH_AES_256_CBC_SHA
- DHE_DSS_WITH_AES_256_CBC_SHA
- RSA_WITH_AES_256_GCM_SHA384
- RSA_WITH_AES_256_CBC_SHA256
- RSA_WITH_AES_256_CBC_SHA
- ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- ECDHE_RSA_WITH_AES_128_GCM_SHA256
- ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- ECDHE_RSA_WITH_AES_128_CBC_SHA256
- ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- ECDHE_RSA_WITH_AES_128_CBC_SHA
- DHE_DSS_WITH_AES_128_GCM_SHA256
- DHE_RSA_WITH_AES_128_GCM_SHA256
- DHE_RSA_WITH_AES_128_CBC_SHA256
- DHE_DSS_WITH_AES_128_CBC_SHA256
- DHE_RSA_WITH_AES_128_CBC_SHA
- DHE_DSS_WITH_AES_128_CBC_SHA
- RSA_WITH_AES_128_GCM_SHA256
- RSA_WITH_AES_128_CBC_SHA256
- RSA_WITH_AES_128_CBC_SHA
- ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- DHE_RSA_WITH_3DES_EDE_CBC_SHA
- DHE_DSS_WITH_3DES_EDE_CBC_SHA
- RSA_WITH_3DES_EDE_CBC_SHA
key_exchange_mechanisms:
type: array
items:
type: string
enum:
- MLKEM512
- MLKEM768
- X25519MLKEM768
- SecP256r1MLKEM768
- MLKEM1024
- SecP384r1MLKEM1024
- p256
- p384
- p521
- x25519
- x448
- ffdhe2048
- ffdhe3072
- ffdhe4096
- ffdhe6144
- ffdhe8192
- brainpoolP256
- brainpoolP384
- brainpoolP512
elliptic_curve_auto_negotiation:
type: boolean
default: true
elliptic_curve:
type:
- array
- 'null'
items:
type: string
enum:
- sect163k1
- sect163r1
- sect163r2
- sect193r1
- sect193r2
- sect233k1
- sect233r1
- sect239k1
- sect283k1
- sect283r1
- sect409k1
- sect409r1
- sect571k1
- sect571r1
- secp160k1
- secp160r1
- secp160r2
- secp192k1
- secp192r1
- prime192v1
- secp224k1
- secp224r1
- secp256k1
- secp256r1
- prime256v1
- secp384r1
- secp521r1
- brainpoolP256r1
- brainpoolP384r1
- brainpoolP512r1
insecure_server_connections:
type: boolean
server_name_indication:
type: boolean
default: true
keystore_url:
type:
- string
- 'null'
format: uri
truststore_url:
type:
- string
- 'null'
format: uri
api_urls:
type: array
items:
type: string
format: uri
global_policy_urls:
type: array
items:
type: string
format: uri
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
SecuredEndpoint:
type:
- object
- 'null'
additionalProperties: false
required:
- endpoint
properties:
endpoint:
type: string
format: uri
tls_client_profile_url:
type:
- string
- 'null'
format: uri
ConfiguredAPIUserRegistry:
type: object
additionalProperties: false
properties:
type:
type: string
readOnly: true
enum:
- configured_api_user_registry
api_version:
type: string
readOnly: true
enum:
- 2.0.0
id:
type: string
readOnly: true
name:
type: string
maxLength: 255
title:
type: string
maxLength: 1023
summary:
type: string
maxLength: 65535
scope:
type: string
user_registry_url:
type: string
format: uri
owned:
type: boolean
integration_url:
type: string
format: uri
registry_type:
type: string
user_managed:
type: boolean
user_registry_managed:
type: boolean
external_group_mapping_enabled:
type: boolean
data_import_keyset_url:
type: string
format: uri
data_export_key:
$ref: '#/components/schemas/PublicKeyJwk'
onboarding:
type:
- string
- 'null'
enum:
- active
- suspended
case_sensitive:
type: boolean
email_required:
type: boolean
default: false
email_unique_if_exist:
type: boolean
default: true
identity_providers:
type: array
items:
type: object
additionalProperties: false
properties:
name:
type: string
title:
type: string
configuration:
type: object
additionalProperties: true
endpoint:
$ref: '#/components/schemas/SecuredEndpoint'
api_urls:
type: array
items:
type: string
format: uri
global_policy_urls:
type: array
items:
type: string
format: uri
space_urls:
type: array
items:
type: string
format: uri
org_url:
type: string
format: uri
catalog_url:
type: string
format: uri
space_url:
type: string
format: uri
metadata:
type: object
additionalProperties:
type: string
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
url:
type: string
readOnly: true
format: uri
SubscriberEventStatus:
type: object
additionalProperties: false
properties:
event_id:
type: string
title:
type: string
filter:
type: string
generated_at:
type: string
processed_at:
type: string
message:
type: string
parameters:
configured-programming-package-version:
name: configured-programming-package-version
in: path
description: Configured Programming Package version name
required: true
schema:
type: string
configured-programming-package-id:
name: configured-programming-package-id
in: path
description: Configured Programming Package name
required: true
schema:
type: string
limit:
name: limit
in: query
description: Maximum number of items to return
required: false
schema:
type: integer
configured-jwt-provider:
name: configured-jwt-provider
in: path
description: Configured Jwt Provider name or id
required: true
schema:
type: string
fields:
name: fields
in: query
description: List of field names to return
required: false
schema:
type: string
org:
name: org
in: path
description: Organization name or id
required: true
schema:
type: string
notification-language:
name: notification-language
in: path
description: Notification Language name or id
required: true
schema:
type: string
configured-programming-package-name:
name: configured-programming-package-name
in: path
description: Configured Programming Package name
required: true
schema:
type: string
configured-tls-client-profile-name:
name: configured-tls-client-profile-name
in: path
description: Configured TLS Client Profile name
required: true
schema:
type: string
configured-api-user-registry:
name: configured-api-user-registry
in: path
description: Configured API User Registry name or id
required: true
schema:
type: string
configured-tls-client-profile-version:
name: configured-tls-client-profile-version
in: path
description: Configured TLS Client Profile version name
required: true
schema:
type: string
offset:
name: offset
in: query
description: Offset item number from list to begin return
required: false
schema:
type: integer
configured-tls-client-profile-id:
name: configured-tls-client-profile-id
in: path
description: Configured TLS Client Profile name
required: true
schema:
type: string
space:
name: space
in: path
description: Space name or id
required: true
schema:
type: string
notification-template:
name: notification-template
in: path
description: Notification Template name or id
required: true
schema:
type: string
configured-gateway-service:
name: configured-gateway-service
in: path
description: Configured Gateway Service name or id
required: true
schema:
type: string
confirm:
name: confirm
in: query
description: Confirmation for critical updates
required: true
schema:
type: string
catalog:
name: catalog
in: path
description: Catalog name or id
required: true
schema:
type: string
role-default:
name: role-default
in: path
description: Role Default name or id
required: true
schema:
type: string
configured-oauth-provider:
name: configured-oauth-provider
in: path
description: Configured Oauth Provider name or id
required: true
schema:
type: string
responses:
Error:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/yaml:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth:
type: oauth2
flows:
implicit:
authorizationUrl: /oauth2/authorize
scopes:
api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version
api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version
app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id
child:create: Create a Catalog object, Create a Space object
child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id
child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id
cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id
cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id
consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id
my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object
my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects
org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id
org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects
product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version
product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version
product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version
product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections
project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version
project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version
provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id
provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id
webhook:manage: Update the Webhook object by name or id
webhook:view: List the Webhook objects, Get the Webhook object by name or id
password:
tokenUrl: /token
refreshUrl: /token
scopes:
api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version
api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version
app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id
child:create: Create a Catalog object, Create a Space object
child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id
child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id
cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id
cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id
consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id
my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object
my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects
org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id
org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects
product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version
product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version
product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version
product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections
project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version
project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version
provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id
provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id
webhook:manage: Update the Webhook object by name or id
webhook:view: List the Webhook objects, Get the Webhook object by name or id
clientCredentials:
tokenUrl: /token
scopes:
api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version
api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version
app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id
child:create: Create a Catalog object, Create a Space object
child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id
child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id
cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id
cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id
consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id
my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object
my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects
org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id
org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects
product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version
product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version
product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version
product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections
project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version
project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version
provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id
provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id
webhook:manage: Update the Webhook object by name or id
webhook:view: List the Webhook objects, Get the Webhook object by name or id
authorizationCode:
authorizationUrl: /oauth2/authorize
tokenUrl: /token
refreshUrl: /token
scopes:
api-drafts:edit: Clear the Draft objects, Create a Draft API object, Clear all Draft API objects in all collections, Clear the Draft API objects, Update the Draft API object by id, Delete the Draft API object by id, Update the Draft API object by name and version, Delete the Draft API object by name and version
api-drafts:view: List the Draft objects, List all Draft API objects in all collections, List the Draft API objects, Get the Draft API object by id, Get the Draft API object by name and version
app:manage:all: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Strategy object, Delete the Strategy object by name or id, Clear the Strategy objects, Update the Strategy object by name or id, Create a Application Credential object, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
app:view:all: List the Application objects, Get the Application object by name or id, List the Strategy objects, Get the Strategy object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
approval:view: List the Task objects, Get the Task object by name or id, Update the Task object by name or id, List the Task History objects, Get the Task History object by name or id
child:create: Create a Catalog object, Create a Space object
child:manage: Clear the Catalog objects, Update the Catalog object by name or id, Delete the Catalog object by name or id, Clear the Space objects, Update the Space object by name or id, Delete the Space object by name or id
child:view: List the Catalog objects, Get the Catalog object by name or id, List the Space objects, Get the Space object by name or id
cloud:manage: Update the Cloud Setting object, Update the User Registry Setting object, Update the Notification Style object, Create a Registration object, Clear the Registration objects, Update the Registration object by name or id, Delete the Registration object by name or id, Update the Webhook object by name or id
cloud:view: Get the Cloud Setting object, Get the User Registry Setting object, Get the Notification Style object, List all Notification Template objects in all collections, List all Role Default objects in all collections, List the Registration objects, Get the Registration object by name or id, List the Webhook objects, Get the Webhook object by name or id
consumer-org:manage: Clear the Activation objects, Delete the Activation object by name or id, Create a Consumer Organization object, Clear the Consumer Organization objects, Update the Consumer Organization object by name or id, Delete the Consumer Organization object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
consumer-org:view: List the Activation objects, Get the Activation object by name or id, List the Consumer Organization objects, Get the Consumer Organization object by name or id, List the Payment Method objects, Get the Payment Method object by name or id
my:manage: Create a API Key object, Delete the API Key object by name or id, Update the Me object, Delete the Me object
my:view: List the API Key objects, Get the API Key object by name or id, Get the Me object, List the My Permission objects, List the My Task objects, List the Originated Task objects, List the My Organization objects, List the My Catalog objects, List the My Space objects, List the My User Group objects, List the My Team objects
org:manage: Update the Log Spec object, Create a User Registry object, Clear the User Registry objects, Update the User Registry object by name or id, Delete the User Registry object by name or id, Create a User object, Clear the User objects, Update the User object by name or id, Delete the User object by name or id, Update the Organization Setting object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Update the Member Invitation object by name or id, Delete the Member Invitation object by name or id, Create a Member object, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a User Group Role Assignment object, Clear the User Group Role Assignment objects, Update the User Group Role Assignment object by name or id, Delete the User Group Role Assignment object by name or id, Create a Role object, Clear the Role objects, Update the Role object by name or id, Delete the Role object by name or id, Create a Availability Zone object, Clear the Availability Zone objects, Update the Availability Zone object by name or id, Delete the Availability Zone object by name or id, Create a Gateway Service object, Clear the Gateway Service objects, Update the Gateway Service object by name or id, Delete the Gateway Service object by name or id, Create a Portal Service object, Clear the Portal Service objects, Update the Portal Service object by name or id, Delete the Portal Service object by name or id, Create a Analytics Service object, Clear the Analytics Service objects, Update the Analytics Service object by name or id, Delete the Analytics Service object by name or id, Create a Opentelemetry object, Clear the Opentelemetry objects, Update the Opentelemetry object by name or id, Delete the Opentelemetry object by name or id, Create a Oauth Provider object, Clear the Oauth Provider objects, Update the Oauth Provider object by name or id, Delete the Oauth Provider object by name or id, Create a Jwt Provider object, Clear the Jwt Provider objects, Update the Jwt Provider object by name or id, Delete the Jwt Provider object by name or id, Create a Mail Server object, Clear the Mail Server objects, Update the Mail Server object by name or id, Delete the Mail Server object by name or id, Create a Billing object, Clear the Billing objects, Update the Billing object by name or id, Delete the Billing object by name or id, Create a Itopsplatform object, Clear the Itopsplatform objects, Update the Itopsplatform object by name or id, Delete the Itopsplatform object by name or id, Clear the Job objects, Delete the Job object by name or id, Create a TLS Server Profile object, Clear all TLS Server Profile objects in all collections, Clear the TLS Server Profile objects, Update the TLS Server Profile object by id, Delete the TLS Server Profile object by id, Update the TLS Server Profile object by name and version, Delete the TLS Server Profile object by name and version, Create a TLS Client Profile object, Clear all TLS Client Profile objects in all collections, Clear the TLS Client Profile objects, Update the TLS Client Profile object by id, Delete the TLS Client Profile object by id, Update the TLS Client Profile object by name and version, Delete the TLS Client Profile object by name and version, Create a Keystore object, Clear the Keystore objects, Update the Keystore object by name or id, Delete the Keystore object by name or id, Create a Truststore object, Clear the Truststore objects, Update the Truststore object by name or id, Delete the Truststore object by name or id, Create a Entry object, Clear the Entry objects, Update the Entry object by name or id, Delete the Entry object by name or id, Create a Jwk Set object, Clear the Jwk Set objects, Delete the Jwk Set object by name or id, Create a Programming Package object, Clear the Programming Package objects, Clear all Programming Package objects in all collections, Update the Programming Package object by id, Update the Programming Package object by name and version, Delete the Programming Package object by id, Delete the Programming Package object by name and version, List all Alias objects in all collections, Clear all Alias objects in all collections, Create a Xslt Transformation Alias object, Clear the Xslt Transformation Alias objects, Clear all Xslt Transformation Alias objects in all collections, Update the Xslt Transformation Alias object by id, Update the Xslt Transformation Alias object by name and version, Delete the Xslt Transformation Alias object by id, Delete the Xslt Transformation Alias object by name and version, Create a Http Transport Security Alias object, Clear the Http Transport Security Alias objects, Clear all Http Transport Security Alias objects in all collections, Update the Http Transport Security Alias object by id, Update the Http Transport Security Alias object by name and version, Delete the Http Transport Security Alias object by id, Delete the Http Transport Security Alias object by name and version, Create a Webmethods Integration Server Service Alias object, Clear the Webmethods Integration Server Service Alias objects, Clear all Webmethods Integration Server Service Alias objects in all collections, Update the Webmethods Integration Server Service Alias object by id, Update the Webmethods Integration Server Service Alias object by name and version, Delete the Webmethods Integration Server Service Alias object by id, Delete the Webmethods Integration Server Service Alias object by name and version, Update the Catalog Setting object, Create a Configured Gateway Service object, Clear the Configured Gateway Service objects, Delete the Configured Gateway Service object by name or id, Create a Configured Catalog User Registry object, Delete the Configured Catalog User Registry object by name or id, Create a Configured API User Registry object, Clear the Configured API User Registry objects, Delete the Configured API User Registry object by name or id, Create a Configured TLS Client Profile object, Clear the Configured TLS Client Profile objects, Delete the Configured TLS Client Profile object by id, Delete the Configured TLS Client Profile object by name and version, Create a Configured Billing object, Clear the Configured Billing objects, Delete the Configured Billing object by name or id, Create a Configured Jwt Provider object, Clear the Configured Jwt Provider objects, Delete the Configured Jwt Provider object by name or id, Create a Configured Oauth Provider object, Clear the Configured Oauth Provider objects, Delete the Configured Oauth Provider object by name or id, Create a Configured Portal Service object, Clear the Configured Portal Service objects, Delete the Configured Portal Service object by name or id, Create a Configured Programming Package object, Clear the Configured Programming Package objects, Delete the Configured Programming Package object by id, Delete the Configured Programming Package object by name and version, List all Configured Alias objects in all collections, Clear all Configured Alias objects in all collections, Create a Configured Xslt Transformation Alias object, Clear the Configured Xslt Transformation Alias objects, Clear all Configured Xslt Transformation Alias objects in all collections, Delete the Configured Xslt Transformation Alias object by id, Delete the Configured Xslt Transformation Alias object by name and version, Create a Configured Webmethods Integration Server Service Alias object, Clear the Configured Webmethods Integration Server Service Alias objects, Clear all Configured Webmethods Integration Server Service Alias objects in all collections, Delete the Configured Webmethods Integration Server Service Alias object by id, Delete the Configured Webmethods Integration Server Service Alias object by name and version, Create a Configured Http Transport Security Alias object, Clear the Configured Http Transport Security Alias objects, Clear all Configured Http Transport Security Alias objects in all collections, Delete the Configured Http Transport Security Alias object by id, Delete the Configured Http Transport Security Alias object by name and version, Augment the Configuration Property with additional name/value pairs, Clear the Configuration Property objects, Update the Configuration Property object, Delete the Configuration Property object, Create a Global Policy object, Clear all Global Policy objects in all collections, Clear the Global Policy objects, Update the Global Policy object by id, Delete the Global Policy object by id, Update the Global Policy object by name and version, Delete the Global Policy object by name and version, Create the Global Policy Error object, Update the Global Policy Error object, Delete the Global Policy Error object, Create the Global Policy Prehook object, Update the Global Policy Prehook object, Delete the Global Policy Prehook object, Create the Global Policy Posthook object, Update the Global Policy Posthook object, Delete the Global Policy Posthook object, Create a Simple Alias object, Clear the Simple Alias objects, Update the Simple Alias object by name or id, Delete the Simple Alias object by name or id, Update the Space Setting object, Update the Consumer Organization Setting object, Delete the Consumer Organization Setting object, Create a Watsonx Settings object, Update the Watsonx Settings object by name or id, Delete the Watsonx Settings object by name or id
org:view: Get the Log Spec object, List the User Registry objects, Get the User Registry object by name or id, List the User objects, Get the User object by name or id, List all Integration objects in all collections, Get the Organization Setting object, Get the Organization object by name or id, List the Associate objects, Get the Associate object by name or id, Create a User Group object, List the User Group objects, Clear the User Group objects, Get the User Group object by name or id, Update the User Group object by name or id, Delete the User Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the Member objects, Get the Member object by name or id, List the User Group Role Assignment objects, Get the User Group Role Assignment object by name or id, List all Permission objects in all collections, List the Role objects, Get the Role object by name or id, Create a Team object, List the Team objects, Clear the Team objects, Get the Team object by name or id, Update the Team object by name or id, Delete the Team object by name or id, List the Availability Zone objects, Get the Availability Zone object by name or id, List the Gateway Service objects, Get the Gateway Service object by name or id, List all Policy objects in all collections, List the Policy objects, Get the Policy object by id, Get the Policy object by name and version, List all Extension objects in all collections, List the Extension objects, Get the Extension object by id, Get the Extension object by name and version, Create the Gateway Extension object, Get the Gateway Extension object, Update the Gateway Extension object, Delete the Gateway Extension object, List the Portal Service objects, Get the Portal Service object by name or id, List the Analytics Service objects, Get the Analytics Service object by name or id, List the Opentelemetry objects, Get the Opentelemetry object by name or id, List the Oauth Provider objects, Get the Oauth Provider object by name or id, List the Jwt Provider objects, Get the Jwt Provider object by name or id, List the Mail Server objects, Get the Mail Server object by name or id, List the Billing objects, Get the Billing object by name or id, List the Itopsplatform objects, Get the Itopsplatform object by name or id, List the Job objects, Get the Job object by name or id, List all TLS Server Profile objects in all collections, List the TLS Server Profile objects, Get the TLS Server Profile object by id, Get the TLS Server Profile object by name and version, List all TLS Client Profile objects in all collections, List the TLS Client Profile objects, Get the TLS Client Profile object by id, Get the TLS Client Profile object by name and version, List the Keystore objects, Get the Keystore object by name or id, List the Truststore objects, Get the Truststore object by name or id, List the Entry objects, Get the Entry object by name or id, List the Jwk Set objects, Get the Jwk Set object by name or id, List the Programming Package objects, List all Programming Package objects in all collections, Get the Programming Package object by id, Get the Programming Package object by name and version, List the Xslt Transformation Alias objects, List all Xslt Transformation Alias objects in all collections, Get the Xslt Transformation Alias object by id, Get the Xslt Transformation Alias object by name and version, List the Http Transport Security Alias objects, List all Http Transport Security Alias objects in all collections, Get the Http Transport Security Alias object by id, Get the Http Transport Security Alias object by name and version, List the Webmethods Integration Server Service Alias objects, List all Webmethods Integration Server Service Alias objects in all collections, Get the Webmethods Integration Server Service Alias object by id, Get the Webmethods Integration Server Service Alias object by name and version, Get the Catalog Setting object, List the Configured Gateway Service objects, Get the Configured Gateway Service object by name or id, List the Configured Catalog User Registry objects, Get the Configured Catalog User Registry object by name or id, List the Configured API User Registry objects, Get the Configured API User Registry object by name or id, List all Configured TLS Client Profile objects in all collections, Clear all Configured TLS Client Profile objects in all collections, List the Configured TLS Client Profile objects, Get the Configured TLS Client Profile object by id, Get the Configured TLS Client Profile object by name and version, List the Configured Billing objects, Get the Configured Billing object by name or id, List the Configured Jwt Provider objects, Get the Configured Jwt Provider object by name or id, List the Configured Oauth Provider objects, Get the Configured Oauth Provider object by name or id, List the Configured Portal Service objects, Get the Configured Portal Service object by name or id, List the Configured Programming Package objects, List all Configured Programming Package objects in all collections, Clear all Configured Programming Package objects in all collections, Get the Configured Programming Package object by id, Get the Configured Programming Package object by name and version, List the Configured Xslt Transformation Alias objects, List all Configured Xslt Transformation Alias objects in all collections, Get the Configured Xslt Transformation Alias object by id, Get the Configured Xslt Transformation Alias object by name and version, List the Configured Webmethods Integration Server Service Alias objects, List all Configured Webmethods Integration Server Service Alias objects in all collections, Get the Configured Webmethods Integration Server Service Alias object by id, Get the Configured Webmethods Integration Server Service Alias object by name and version, List the Configured Http Transport Security Alias objects, List all Configured Http Transport Security Alias objects in all collections, Get the Configured Http Transport Security Alias object by id, Get the Configured Http Transport Security Alias object by name and version, List the Configuration Property objects, Get the Configuration Property object, List all Global Policy objects in all collections, List the Global Policy objects, Get the Global Policy object by id, Get the Global Policy object by name and version, Get the Global Policy Error object, Get the Global Policy Prehook object, Get the Global Policy Posthook object, List the Simple Alias objects, Get the Simple Alias object by name or id, Get the Space Setting object, Get the Consumer Organization Setting object, List the Primary Event objects, Get the Primary Event object by name or id, List the Subscriber Event objects, Get the Subscriber Event object by name or id, List the Task Queue objects, Get the Task Queue object by name or id, List the Watsonx Settings objects, Get the Watsonx Settings object by name or id, List the Resource Service Status objects
product-drafts:edit: Create a Draft Product object, Clear all Draft Product objects in all collections, Clear the Draft Product objects, Update the Draft Product object by id, Delete the Draft Product object by id, Update the Draft Product object by name and version, Delete the Draft Product object by name and version
product-drafts:view: List all Draft Product objects in all collections, List the Draft Product objects, Get the Draft Product object by id, Get the Draft Product object by name and version
product:manage: Clear all Product objects in all collections, Clear the Product objects, Update the Product object by id, Delete the Product object by id, Update the Product object by name and version, Delete the Product object by name and version, Update the API object by id, Update the API object by name and version
product:view: List all Product objects in all collections, List the Product objects, Get the Product object by id, Get the Product object by name and version, List all API objects in all collections, List the API objects, Get the API object by id, Get the API object by name and version, Get the Plan object by id, Get the Plan object by name and version, List the Plan objects, List all Plan objects in all collections, Get the Quota object by id, Get the Quota object by name and version, List the Quota objects, List all Quota objects in all collections
project:manage: Create a Project object, Clear the Project objects, Update the Project object by name or id, Delete the Project object by name or id, Clear the Project File objects, Clear all Project File objects in all collections, Update the Project File object by id, Update the Project File object by name and version, Delete the Project File object by id, Delete the Project File object by name and version
project:view: List the Project objects, Get the Project object by name or id, List the Project File objects, List all Project File objects in all collections, Get the Project File object by id, Get the Project File object by name and version
provider-org:manage: Create an Organization Invitation object, Clear the Organization Invitation objects, Update the Organization Invitation object by name or id, Delete the Organization Invitation object by name or id, Create a Group object, Clear the Group objects, Update the Group object by name or id, Delete the Group object by name or id
provider-org:view: List the Organization Invitation objects, Get the Organization Invitation object by name or id, List the Group objects, Get the Group object by name or id
webhook:manage: Update the Webhook object by name or id
webhook:view: List the Webhook objects, Get the Webhook object by name or id
x-ibm-configuration:
testable: false