Security Domain API
{ urn:com.soa.securitydomain.api } SecurityDomainAPI
This API allows security domains to be queried and manipulated. Note: The POST API will return an HTTP 401 error if the user doesn’t have add privileges on a domain. The GET and PUT API will return an HTTP 401 error if the user doesn’t have read privileges on a domain, the domain is not accessible to the user, or the domain doesn’t exist.
GET/securitydomainsgetSecurityDomains
Parameters
Name
Type
Description
Model
DomainType
query
string
SupportsLoginProcess
query
string
SupportsInteractiveAuth
query
string
SupportsAuth
query
string
SupportsAuthorization
query
string
SupportsIdBrowse
query
string
IncludeRegistryDomains
query
boolean
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
rss
rss {
rssChannel {
rssImage {
rssItem {
rssEnclosure {
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
rssSkipDays {
rssCloud {
rssTextInput {
channel( rssChannel )
version( string )
}
rssChannel {
image( rssImage )
copyright( string )
item( rssItem )
skipHours( rssSkipHours )
lastBuildDate( string )
link( anyURI )
rating( string )
description( string )
generator( string )
language( string )
title( string )
managingEditor( string )
webMaster( string )
pubDate( string )
ttl( int )
skipDays( rssSkipDays )
cloud( rssCloud )
textInput( rssTextInput )
docs( anyURI )
category( rssCategory )
}
rssImage {
link( anyURI )
width( int )
description( string )
title( string )
url( string )
height( int )
}
rssItem {
comments( anyURI )
enclosure( rssEnclosure )
author( string )
link( anyURI )
description( string )
guid( rssGuid )
source( rssSource )
title( string )
category( rssCategory )
pubDate( string )
}
rssEnclosure {
length( string )
type( string )
url( string )
}
rssGuid {}
rssSource {}
rssCategory {}
rssSkipHours {
hour( Collection of string )
}
rssSkipDays {
day( Collection of string )
}
rssCloud {
path( string )
protocol( string )
port( int )
registerProcedure( string )
domain( string )
}
rssTextInput {
name( string )
link( anyURI )
description( string )
title( string )
}
POST/securitydomainsaddSecurityDomain
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
body
entity
SecurityDomain
SecurityDomain {
Description( string )
IdentitySystemType( string, required )
DomainConfiguration( string, required )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/securitydomains/{DomainID}getSecurityDomain
Parameters
Name
Type
Description
Model
DomainID
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
any
PUT/securitydomains/{DomainID}updateSecurityDomain
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
DomainID
path
string
body
entity
SecurityDomain
SecurityDomain {
Description( string )
IdentitySystemType( string, required )
DomainConfiguration( string, required )
Name( string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
DELETE/securitydomains/{DomainID}deleteSecurityDomain
Parameters
Name
Type
Description
Model
DomainID
path
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/securitydomains/{DomainID}/oauthproviderconfiggetSecurityDomainOAuthProviderConfig
Parameters
Name
Type
Description
Model
DomainID
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
any
PUT/securitydomains/{DomainID}/resources/{Resource}saveDomainResource
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
DomainID
path
string
Resource
path
string
DropBoxEntryID
form
long
Reponse
Status Code
Reason
Model
200
Success
string
GET/securitydomains/{DomainID}/resources/{Resource}getDomainResource
Parameters
Name
Type
Description
Model
DomainID
path
string
Resource
path
string
Reponse
Produces image/jpeg
Status Code
Reason
Model
200
Success
byte