Tenant Administration API
{ urn:com.soa.tenant.admin.api } TenantAdministrationAPI
The Tenant Administation service includes operations relating to managing settings for a platform tenant.
GET/tenants/{TenantFedMemberID}getTenant
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessAppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
AppVersionWorkflowDefKey( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
AppTeamMemberWorkflowDefKey( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
BusinessAPISettings {
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
APIWithExistingServiceSupport( string )
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIIndependentGroupSupport( string )
PublicAPIReviewsSupport( string )
ApiVersionWorkflowDefKey( string )
PublicAPIProductionAutoApprovalSupport( string )
APIWithAnonymousAccessSupport( string )
APIPromotionSupport( string )
ValidateUniqueContextPath( string )
PrivateAPISandboxEndpointSupport( string )
ApiAdminMemberWorkflowDefKey( string )
APIWithNewServiceSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
PUT/tenants/{TenantFedMemberID}updateTenant
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string, required )
PlatformApiClientID( string )
Business( Business, required )
}
Theme {
TenantID( long, required )
FedmemberID( string, required )
Alias( string, required )
ConsoleAddress( string, required )
Theme( string, required )
SiteTitle( string, required )
SiteDescription( string, required )
VirtualHosts( Collection of string, required )
ThemeImpl( string, required )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings, required )
ModelCategories( Collection of ModelCategory, required )
BusinessType( string )
TicketSettings( TicketSettings, required )
BusinessAppSettings( BusinessAppSettings, required )
BusinessAPISettings( BusinessAPISettings, required )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings, required )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings, required )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings, required )
BusinessKey( string, required )
Contact( string )
TargetResources( Collection of TargetResource, required )
Visibility( string )
AlertSettings( AlertSettings, required )
IsFollowed( boolean )
BusinessID( string, required )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings, required )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean, required )
Name( string, required )
}
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessAppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
AppVersionWorkflowDefKey( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
AppTeamMemberWorkflowDefKey( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
BusinessAPISettings {
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
APIWithExistingServiceSupport( string )
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIIndependentGroupSupport( string )
PublicAPIReviewsSupport( string )
ApiVersionWorkflowDefKey( string )
PublicAPIProductionAutoApprovalSupport( string )
APIWithAnonymousAccessSupport( string )
APIPromotionSupport( string )
ValidateUniqueContextPath( string )
PrivateAPISandboxEndpointSupport( string )
ApiAdminMemberWorkflowDefKey( string )
APIWithNewServiceSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string, required )
Environment( string, required )
ConnectionCommentWorkflowDefKey( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image, required )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string, required )
Url( anyURI, required )
Link( anyURI, required )
}
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Tenant
Tenant {
Theme {
Business {
BusinessDiscussionSettings {
ModelCategory {
TicketSettings {
BusinessAppSettings {
BusinessAPISettings {
BusinessReviewSettings {
BusinessUserSettings {
ConnectionWorkflowSetting {
CommentSettings {
TargetResource {
Image {
AlertSettings {
BusinessGroupSettings {
PlatformApiContractExists( boolean )
FromEmailAddress( string )
IndexTargets( Collection of string )
Description( string )
Address( string )
TenantName( string )
ForwardProxyAllowedHosts( Collection of string )
AnalyticsAccountID( string )
Themes( Collection of Theme )
ESIndexName( string )
SearchSource( string )
AvatarURL( anyURI )
ContactEmailAddress( string )
LaaSIntegrationSupport( string )
AdminGroupID( string )
State( string )
ConsoleAddress( string )
FedMemberID( string )
PlatformApiClientID( string )
Business( Business )
}
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
Business {
Description( string )
BusinessDiscussionSettings( BusinessDiscussionSettings )
ModelCategories( Collection of ModelCategory )
BusinessType( string )
TicketSettings( TicketSettings )
BusinessAppSettings( BusinessAppSettings )
BusinessAPISettings( BusinessAPISettings )
Name( string )
Created( dateTime )
BusinessReviewSettings( BusinessReviewSettings )
AvatarURL( anyURI )
AdminGroupID( string )
BusinessAdminMemberWorkflowDefKey( string )
Picture( anyURI )
ModelVersionWorkflowDefKey( string )
BusinessUserSettings( BusinessUserSettings )
ConnectionSettings( Collection of ConnectionWorkflowSetting )
Updated( dateTime )
MaxFileSizeForUpload( int )
PictureID( long )
ParentBusinessID( string )
CommentSettings( CommentSettings )
BusinessKey( string )
Contact( string )
TargetResources( Collection of TargetResource )
Visibility( string )
AlertSettings( AlertSettings )
IsFollowed( boolean )
BusinessID( string )
Link( anyURI )
BusinessGroupSettings( BusinessGroupSettings )
}
BusinessDiscussionSettings {
AutoPublish( boolean )
DiscussionWorkflowDefKey( string )
DiscussionCommentWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
ModelCategory {
Description( string )
Deleted( boolean )
Name( string )
}
TicketSettings {
TicketSupport( string )
TicketWorkflowDefKey( string )
TicketCommentWorkflowDefKey( string )
Visibility( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessAppSettings {
SimultaneousSandboxProductAccessSupport( string )
PublicAppRatingsSupport( string )
PrivateAppReviewsSupport( string )
AppPromotionSupport( string )
PublicAppSupport( string )
RegisteredUsersAppRatingsSupport( string )
PrivateAppRatingsSupport( string )
RegisteredUsersAppReviewsSupport( string )
PublicAppBoardSupport( string )
AppVersionWorkflowDefKey( string )
PrivateAppBoardSupport( string )
PrivateAppSupport( string )
AppTeamMemberWorkflowDefKey( string )
ContractPoliciesSupport( string )
PublicAppReviewsSupport( string )
ReturnPlainTextSharedSecret( string )
UserDefinedIdentitySupport( string )
RegisteredUsersAppSupport( string )
}
BusinessAPISettings {
PrivateAPIBoardSupport( string )
PublicAPISandboxEndpointSupport( string )
PublicAPIRatingsSupport( string )
PrivateAPIResourceLevelPermissionsSupport( string )
PublicAPISandboxAutoApprovalSupport( string )
PublicAPIResourceLevelPermissionsSupport( string )
PrivateAPISupport( string )
PrivateAPISandboxAutoApprovalSupport( string )
PrivateAPIProductionEndpointSupport( string )
PublicAPIBoardSupport( string )
PrivateAPIReviewsSupport( string )
PublicAPIProductionEndpointSupport( string )
APIWithExistingServiceSupport( string )
PrivateAPIRatingsSupport( string )
PrivateAPIGroupTypeSupport( string )
PrivateAPIIndependentGroupSupport( string )
PublicAPIReviewsSupport( string )
ApiVersionWorkflowDefKey( string )
PublicAPIProductionAutoApprovalSupport( string )
APIWithAnonymousAccessSupport( string )
APIPromotionSupport( string )
ValidateUniqueContextPath( string )
PrivateAPISandboxEndpointSupport( string )
ApiAdminMemberWorkflowDefKey( string )
APIWithNewServiceSupport( string )
PublicAPISupport( string )
PrivateAPIProductionAutoApprovalSupport( string )
}
BusinessReviewSettings {
AutoPublish( boolean )
ReviewWorkflowDefKey( string )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessUserSettings {
UserWorkflowDefKey( string )
SelfSignup( string )
InviteUnregisteredUsers( string )
InvitedUserValidDays( int )
TopApisCountAllowed( int )
UpdateEmailValidCodeHours( int )
SignupUserValidDays( int )
NewsUpdateNotification( string )
AddedUserValidDays( int )
ResetValidCodeHours( int )
EnforceChallengesSetupOnLogin( string )
}
ConnectionWorkflowSetting {
WorkflowDefinitionKey( string )
Environment( string )
ConnectionCommentWorkflowDefKey( string )
}
CommentSettings {
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
TargetResource {
Type( string )
IsResourceLevelPermissionSupported( boolean )
Visibility( string )
ID( string )
Image( Image )
Avatar( string )
Name( string )
}
Image {
Description( string )
Title( string )
Url( anyURI )
Link( anyURI )
}
AlertSettings {
AlertWorkflowDefKey( string )
AlertCommentWorkflowDefKey( string )
AutoPublish( boolean )
MarkdownSupport( string )
ExternalLinkSupport( string )
}
BusinessGroupSettings {
PrivateGroupReviewsSupport( string )
GroupMemberWorkflowDefKey( string )
PublicGroupSupport( string )
PublicGroupBoardSupport( string )
PrivateGroupSupport( string )
GroupCommentWorkflowDefKey( string )
GroupSupport( string )
PublicGroupRatingsSupport( string )
PrivateGroupRatingsSupport( string )
PublicGroupReviewsSupport( string )
PrivateGroupBoardSupport( string )
}
POST/tenants/supportcontactSupport
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
Name
form
string
Email
form
string
Category
form
string
Subject
form
string
Question
form
string
DELETE/tenants/{TenantFedMemberID}removeTenant
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
GET/tenants/{ResourceID}/packageexport
Parameters
Accepts */*
Name
Type
Description
Model
ResourceID
path
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
byte
POST/tenants/{TenantFedMemberID}/packagesimportPackage
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
base64Binary
Reponse
Produces application/jsontext/xmlapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
promotionConfig
promotionConfig {
mapping {
property {
tenantAddress( string )
exportKey( string )
created( dateTime )
preserveKeysOverride( boolean )
exportName( string )
preserveSharedSecret( boolean )
version( string )
preserveKeys( boolean )
assets( Collection of mapping )
exportType( ExportType )
tenantId( string )
promotionMode( boolean )
preserveOutboundIdentities( boolean )
environmentUrl( string )
}
mapping {
sourceId( string )
targetId( string )
exportType( ExportType )
parentMapping( mapping )
properties( Collection of property )
}
property {
name( string )
properties( Collection of property )
}
POST/tenants/{TenantFedMemberID}/packagesasyncimportPackageAsync
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
base64Binary
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
promotionStatus
promotionStatus {
promotionConfig {
mapping {
property {
importOperationKey( string )
promotionConfig( promotionConfig )
error( string )
promotionStatus( promotionStatusEnum )
}
promotionConfig {
tenantAddress( string )
exportKey( string )
created( dateTime )
preserveKeysOverride( boolean )
exportName( string )
preserveSharedSecret( boolean )
version( string )
preserveKeys( boolean )
assets( Collection of mapping )
exportType( ExportType )
tenantId( string )
promotionMode( boolean )
preserveOutboundIdentities( boolean )
environmentUrl( string )
}
mapping {
sourceId( string )
targetId( string )
exportType( ExportType )
parentMapping( mapping )
properties( Collection of property )
}
property {
name( string )
properties( Collection of property )
}
GET/tenants/{TenantFedMemberID}/countrycodesgetTenantCountryCodes
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
CountryCode
CountryCode {
id( string )
Name( string )
}
PUT/tenants/{TenantFedMemberID}/countrycodessaveTenantCountryCodes
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
CountryCodes
CountryCodes {
CountryCode {
CountryCode( Collection of CountryCode, required )
}
CountryCode {
id( string, required )
Name( string )
}
GET/tenants/{TenantFedMemberID}/themesgetTenantThemes
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
Theme
Theme {
TenantID( long )
FedmemberID( string )
Alias( string )
ConsoleAddress( string )
Theme( string )
SiteTitle( string )
SiteDescription( string )
VirtualHosts( Collection of string )
ThemeImpl( string )
}
PUT/tenants/{TenantFedMemberID}/repositoryconfigupdateRepositoryConfiguration
Parameters
Accepts application/json application/vnd.soa.v84+json
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
RepositoryConfiguration
RepositoryConfiguration {
environmentConfiguration {
atomLink {
properties {}
apiImplementationProfiles {}
filters {
classifierCriteria {
valueSetValue {
environmentConfiguration( environmentConfiguration, required )
filters( Collection of filters )
}
environmentConfiguration {
links( Collection of atomLink )
properties( Collection of properties )
apiImplementationProfiles( Collection of apiImplementationProfiles )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
lang( string )
base( anyURI )
}
properties {}
apiImplementationProfiles {}
filters {
classifier-criteria( Collection of classifierCriteria )
name( string )
links( Collection of atomLink )
}
classifierCriteria {
values( Collection of valueSetValue )
classifierName( string )
}
valueSetValue {
regularExpression( boolean )
value( string )
}
POST/tenants/{TenantFedMemberID}/fedmembersaddTrustedFederationMember
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
FedMember
FedMember {
ProxyAddress( string )
Address( string )
CmApiVersion( string )
IsLocal( boolean )
FedMemberID( string, required )
ESIndexName( string )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/tenants/{TenantFedMemberID}/administratorsaddSiteAdministrator
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
TenantFedMemberID
path
string
UserID
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/tenants/{TenantFedMemberID}/importimportFile
Parameters
Accepts text/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v80+json application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
TenantFedMemberID
path
string
body
entity
ImportParameters
ImportParameters {
MappingLocation( anyURI )
PackageLocation( anyURI, required )
OrganizationKey( string )
}
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
promotionConfig
promotionConfig {
mapping {
property {
tenantAddress( string )
exportKey( string )
created( dateTime )
preserveKeysOverride( boolean )
exportName( string )
preserveSharedSecret( boolean )
version( string )
preserveKeys( boolean )
assets( Collection of mapping )
exportType( ExportType )
tenantId( string )
promotionMode( boolean )
preserveOutboundIdentities( boolean )
environmentUrl( string )
}
mapping {
sourceId( string )
targetId( string )
exportType( ExportType )
parentMapping( mapping )
properties( Collection of property )
}
property {
name( string )
properties( Collection of property )
}
GET/tenants/{ID}/picturegetImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte
GET/tenants/{ID}/avatargetDefaultAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/tenants/{ID}/previewavatarpreviewAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Provider
query
string
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
any
POST/tenants/{ID}/pictureupdateImage
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
ID
path
string
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
DELETE/tenants/{ID}/picturedeleteImage
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/tenants/{TenantFedMemberID}/packagesasync/{ImportOperationKey}importPackageAsyncPoll
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
ImportOperationKey
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
promotionStatus
promotionStatus {
promotionConfig {
mapping {
property {
importOperationKey( string )
promotionConfig( promotionConfig )
error( string )
promotionStatus( promotionStatusEnum )
}
promotionConfig {
tenantAddress( string )
exportKey( string )
created( dateTime )
preserveKeysOverride( boolean )
exportName( string )
preserveSharedSecret( boolean )
version( string )
preserveKeys( boolean )
assets( Collection of mapping )
exportType( ExportType )
tenantId( string )
promotionMode( boolean )
preserveOutboundIdentities( boolean )
environmentUrl( string )
}
mapping {
sourceId( string )
targetId( string )
exportType( ExportType )
parentMapping( mapping )
properties( Collection of property )
}
property {
name( string )
properties( Collection of property )
}
DELETE/tenants/{TenantFedMemberID}/administrators/{UserID}removeSiteAdministrator
Parameters
Accepts */*
Name
Type
Description
Model
TenantFedMemberID
path
string
UserID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/tenants/{ID}/avatars/{version}.pnggetAvatar
Parameters
Accepts */*
Name
Type
Description
Model
ID
path
string
version
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
POST/tenants/{TenantFedMemberID}/theme/{theme}/pkiuploadTenantThemePKI
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
TenantFedMemberID
path
string
theme
path
string
keystorePass
query
Keystore password.
string
alias
query
Alias in the keystore to use.
string
aliasPass
query
Alias password. Can be omitted if not needed or the same as the keystore password.
string
forceTrust
query
Add to trust store if not trusted already. If false and not trusted an error will be returned. Can be omitted. Default is false.
boolean
body
entity
The uploaded file.
base64Binary
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v85+json
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
GET/tenants/{TenantFedMemberID}/theme/{theme}/pkigetTenantThemePKI
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
theme
path
string
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v85+json
Status Code
Reason
Model
200
Success
pkiAndCertificateInfo
pkiAndCertificateInfo {
atomLink {
availablePKIManagementOptions {
certificateInfo {
privateKeyExists( boolean )
Links( Collection of atomLink )
publicKey( string )
managementOptions( availablePKIManagementOptions )
certificateInfo( certificateInfo )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
availablePKIManagementOptions {
import( boolean )
export( boolean )
delete( boolean )
assign( boolean )
}
certificateInfo {
issuerDN( string )
effectiveDate( long )
subjectDN( string )
serialNo( string )
expirationDate( long )
}
DELETE/tenants/{TenantFedMemberID}/theme/{theme}/pkideleteTenantThemePKI
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
theme
path
string
Reponse
Produces text/plain
GET/tenants/{TenantFedMemberID}/{environment}/promotion/contextgetEnvironmentPromotionContext
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
environment
path
string
includeServiceInfo
query
Include Service Information.
boolean
includeAPIInfo
query
Include API Information.
boolean
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
environmentContext
environmentContext {
processes {
apiVersions {
policies {}
resources {
atomLink {
services {
scripts {
businesses {
properties {}
processes( Collection of processes )
apiVersions( Collection of apiVersions )
policies( Collection of policies )
resources( Collection of resources )
links( Collection of atomLink )
services( Collection of services )
scripts( Collection of scripts )
businesses( Collection of businesses )
properties( Collection of properties )
}
processes {
organizationId( string )
processId( string )
processName( string )
}
apiVersions {
organizationId( string )
lastUpdated( dateTime )
apiName( string )
apiVersion( string )
businessId( string )
apiVersionId( string )
apiId( string )
}
policies {}
resources {
resourceId( string )
businessId( string )
resourceName( string )
parentResourceId( string )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
lang( string )
base( anyURI )
}
services {
serviceVersion( string )
organizationId( string )
lastUpdated( dateTime )
virtual( boolean )
serviceQname( string )
serviceId( string )
serviceName( string )
}
scripts {
organizationId( string )
scriptId( string )
scriptName( string )
}
businesses {
organizationId( string )
name( string )
description( string )
id( string )
parentId( string )
}
properties {}
GET/tenants/avatar/{version}{Extension:(/[^/]+?)*}getDefaultVersionedAvatar
Parameters
Accepts */*
Name
Type
Description
Model
version
path
string
Extension
path
string
size
query
integer
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/tenants/{TenantFedMemberID}/theme/{theme}/pki/exportexportTenantThemePKI
Parameters
Name
Type
Description
Model
TenantFedMemberID
path
string
theme
path
string
Reponse
Produces application/octet-stream
Status Code
Reason
Model
200
Success
byte
